diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 16cf8465fca..dddd53040d0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,7 +24,7 @@ jobs: timeout-minutes: 10 name: lint runs-on: ${{ github.repository == 'stainless-sdks/cloudflare-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} - if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') + if: github.repository == 'cloudflare/cloudflare-python' && (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - uses: actions/checkout@v6 @@ -40,7 +40,7 @@ jobs: run: ./scripts/lint build: - if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') + if: github.repository == 'cloudflare/cloudflare-python' && (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') timeout-minutes: 10 name: build permissions: @@ -84,7 +84,7 @@ jobs: timeout-minutes: 30 name: test runs-on: ${{ github.repository == 'stainless-sdks/cloudflare-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} - if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + if: github.repository == 'cloudflare/cloudflare-python' && (github.event_name == 'push' || github.event.pull_request.head.repo.fork) steps: - uses: actions/checkout@v6 diff --git a/.github/workflows/detect-breaking-changes.yml b/.github/workflows/detect-breaking-changes.yml index d52da5d5f55..489aae4656c 100644 --- a/.github/workflows/detect-breaking-changes.yml +++ b/.github/workflows/detect-breaking-changes.yml @@ -7,6 +7,7 @@ on: jobs: detect_breaking_changes: + if: github.repository == 'cloudflare/cloudflare-python' runs-on: 'ubuntu-latest' name: detect-breaking-changes permissions: diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 8631c071446..e5eb0e6a7c8 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -10,6 +10,7 @@ on: jobs: publish: + if: github.repository == 'cloudflare/cloudflare-python' name: publish permissions: contents: read diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml index b7edd0d6ad7..29b560d32d7 100644 --- a/.github/workflows/semgrep.yml +++ b/.github/workflows/semgrep.yml @@ -5,6 +5,7 @@ on: name: Semgrep config jobs: semgrep: + if: github.repository == 'cloudflare/cloudflare-python' name: semgrep/ci permissions: contents: read diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index d5102f68719..46f88fe19a2 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -8,6 +8,7 @@ on: - .github/labels.yml jobs: build: + if: github.repository == 'cloudflare/cloudflare-python' permissions: issues: write # action-label-syncer creates/updates repo labels runs-on: ubuntu-latest diff --git a/stackql_cloudflare/CLAUDE.md b/stackql_cloudflare/CLAUDE.md index f097d22be9c..d44c64f2aba 100644 --- a/stackql_cloudflare/CLAUDE.md +++ b/stackql_cloudflare/CLAUDE.md @@ -44,6 +44,11 @@ stackql_cloudflare/ # ← project root │ ├── fanout.py # Explode dual-scope /{accounts_or_zones}/... paths │ ├── rename.py # Schema→camelCase, path-params→snake_case │ ├── canonical_params.py # Standardise common path-param definitions +│ ├── octet_stream_requests.py # Step 3 post-pass: octet-stream request bodies +│ ├── ai_task_families.py # Step 3 post-pass: collapse Workers AI models into task families +│ ├── select_response_fixes.py # Step 3 post-pass: fix empty-column select response shapes +│ ├── octet_stream_docs.py # Step 4 post-pass: data__ prefixes in doc examples +│ ├── ai_docs_enhance.py # Step 4 post-pass: model admonitions + runnable AI select examples │ ├── normalize.py # Schema flattener (kills allOf/oneOf/anyOf/additionalProperties) │ └── fold_singletons.py # One-shot CSV mutation (already applied) ├── bin/ @@ -52,7 +57,8 @@ stackql_cloudflare/ # ← project root │ ├── start-server.sh # Local stackql server (Linux/macOS/WSL only) │ ├── stop-server.sh │ ├── server-status.sh -│ └── test-meta-routes.cjs # Smoke-test every SHOW/DESCRIBE route +│ ├── test-meta-routes.cjs # Smoke-test every SHOW/DESCRIBE route +│ └── smoke-test-kv.cjs # Full-cycle KV smoke test (live API) ├── provider-dev/ │ ├── downloads/cloudflare-openapi.json # Cached upstream spec (~17 MB) │ ├── source/.yaml # Step 1 output (108 service files) @@ -69,6 +75,15 @@ stackql_cloudflare/ # ← project root ## Pipeline (run from the project root) +The whole chain is wrapped in a `Makefile` (run from WSL/Linux/macOS): +`make all` = specs -> mappings (strict gate: fails on unmapped operations) +-> provider (incl. all post-passes) -> meta-test (go/no-go SHOW/DESCRIBE +walk via a local server) -> docs (incl. post-passes). Individual targets: +`make specs`, `make specs-refresh`, `make mappings`, `make provider`, +`make meta-test`, `make docs`, `make smoke-test-kv` (live API, needs +CLOUDFLARE_API_TOKEN + CLOUDFLARE_ACCOUNT_ID, deliberately NOT in `all`), +`make help`. The underlying step commands: + ```bash # Step 1: download + transform upstream OpenAPI into per-service yamls python -m stackql_cloudflare_provider.generate_specs --clean @@ -186,7 +201,11 @@ op_description **Identity key**: `(filename, path, verb)`. On re-run, the four columns `stackql_resource_name`, `stackql_method_name`, `stackql_verb`, `stackql_object_key` are **preserved verbatim** if the user has edited them -(non-default value). `--reset` forces re-defaulting. +(non-default value). `--reset` forces re-defaulting. `--strict` (used by +`make mappings`) exits non-zero when any operation has no existing CSV row +OR any row carries a hash-suffixed resource/method name (disambiguation +fallback) - default rows are still written so the user can curate/rename +them and re-run. The provider is hash-suffix free as of 2026-07-21. ### Verb classification (`_refine_stackql_verb`) @@ -330,6 +349,68 @@ get this transform across ~80 services. Methods whose body has only scalar properties are left alone - the naive translator handles those correctly. +Then **`octet_stream_requests.py`** runs as a third post-pass. It +targets the handful of write endpoints whose request body is +`application/octet-stream` (KV value PUT, 5 Workers AI binary-input +models, 2 DLP dataset uploads - 8 methods total). The whole body is the +raw payload, so JSON body translation makes no sense: the pass drops +the `naive` requestBodyTranslate from those methods ONLY, injects a +`stackql`-prefixed wrapper schema (e.g. `stackqlWorkersKvValueBody`) +exposing a single required `value` column via `request.schema_override`, +and splats it verbatim onto the wire: + +```yaml +request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersKvValueBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' +``` + +Because naive translation is off for these methods, callers MUST use +the `data__` prefix: + +```sql +REPLACE cloudflare.kv.values +SET data__value = 'my-raw-value' +WHERE account_id = '...' AND namespace_id = '...' AND key_name = '...'; +``` + +Then **`ai_task_families.py`** runs as a fourth post-pass. Driven by +`provider-dev/config/ai_task_families.yaml`, it collapses the ~93 +per-model Workers AI run resources into 9 task-family SELECT resources +(`ai.text_generation`, `ai.text_embeddings`, `ai.text_to_image`, +`ai.speech_to_text`, `ai.text_to_speech`, `ai.text_classification`, +`ai.translation`, `ai.summarization`, `ai.reranking`), all riding the +generic `POST /accounts/{account_id}/ai/run/{model_name}` operation with +`model_name` as the discriminator (slash-containing values substitute +literally into the URL - verified live). Mechanics: + +- SELECT WHERE params bind to request-body properties with UNPREFIXED + names (`WHERE prompt = '...'`); `data__` does NOT apply to SELECT. +- The generic op's 200 response is rewritten to a typed union envelope + (`stackqlAiRunResponseEnvelope`); object-mode families project + `objectKey: $.result` (typed columns like `response`, `usage`, `data`, + `shape`); contents-mode families (image/audio/array results) wrap the + raw response as a `contents` column. +- Per-family `request.schema_override` -> `stackqlAiRunInput` + (union of member body schemas) + a `request.transform` that + serialises exactly the provided WHERE params. +- Member models' per-model paths and resources are DROPPED from the + generated ai.yaml (ai went from ~123 resources to 30). The 5 + octet-stream-input models (whisper x2, resnet x2, detr) are excluded + and keep their per-model insert resources. +- Generic `ai.run` stays as the escape hatch for unlisted models. + +Example: `SELECT response FROM cloudflare.ai.text_generation WHERE +account_id = '...' AND model_name = '@cf/meta/llama-3.2-1b-instruct' +AND prompt = '...'` - each SELECT executes (and bills) an inference +call. + --- ## Step 4 — docs generation @@ -357,6 +438,15 @@ Then **`sanitize_docs.py`** runs as a post-pass. It: the generator actually emits (keeps `#methods`, `#parameter-*`, `#get*`/`#list*`/CRUD method anchors). +Then **`octet_stream_docs.py`** runs as a second post-pass. It discovers +every resource method carrying `request.mediaType: +application/octet-stream` in the generated provider yamls (attached by +`octet_stream_requests.py`, so the two passes can't drift) and rewrites +that method's SQL example on the matching docs page to show the body +column `data__`-prefixed (`SET data__value = '{{ value }}'`, or +`data__value` first in the INSERT column list). Only the matched +TabItem's sql block is touched. Idempotent. + --- ## Key design decisions (and *why*) @@ -427,6 +517,32 @@ download. Critical default: registry path is `provider-dev/openapi` ## Conventions and gotchas +### Resource / method mapping heuristics (user's rules, 2026-07-21) + +When reviewing CSV mappings (new upstream ops or cleanup passes), apply +these smell tests: + +- A resource prefixed with `by_` is probably a method of another + resource accessed with a different discriminator (e.g. rulesets + `by_tag` -> `rulesets.list_rules_by_tag_*`). +- A resource name containing a verb (`requests_new`, `events_create`, + `relate_create`) is probably a method for the noun resource. +- Redundant doubled names (`builds_builds`) are incorrect - merge. +- Repeating the service name in a resource name is redundant + (`workers.workers_versions` -> `workers.versions`). +- A singular resource next to a plural sibling is usually wrong - + resources should generally be plural (`exclude` -> `excludes`, + `subdomain` folded into `subdomains`, `integration` -> + `integrations`). +- Hash-suffixed resources (`audit_logs_6f0256`) are pass-3 + disambiguation fallbacks - remap them as differently-named methods on + one resource (`list_by_account`, `list_by_account_issue`, + `list_by_zone`, ...) whose required-param signatures differ. +- Two select methods on one resource MUST have different required-param + signatures or the meta gate fails - when they collide (e.g. workers + `scripts-search` vs `scripts.list`, both `{account_id}`), map the + action-flavoured one as exec instead. + ### Identifier casing rules (user's mandate) - **Schema names**: camelCase (we don't care — opaque to StackQL). @@ -539,6 +655,86 @@ cd website && yarn start ## What's been done recently +- Mapping cleanup round 3 (2026-07-21): SERVICE rename `aisearch` -> + `ai_search` (split.py capability map, source yaml renamed + internal + title/x-stackql-sdk refs patched, 48 CSV filename rows, stale + generated yaml deleted - service renames touch all four). GraphQL + manifest resources de-prefixed (`dns.analytics_adaptive_groups`, + `d1.analytics_adaptive_groups`, `r2.operations_adaptive_groups`; + GRAPHQL.md + examples/analytics updated). CSV renames/merges: images + v1 -> images_v1, v2 list merged into images; intel + intel_indicator_feeds -> indicator_feeds.list; pagerules -> + page_rules; accounts_pipelines merged into pipelines; + rulesets_versions merged into versions (now selectable); + securitytxt -> security_txt; speed_api_pages -> api_pages; + r2_catalog_maintenance_configs -> maintenance_configs; dns bytimes -> + reports_by_times; dns_firewall bytimes -> dimensions_and_metrics. + Non-selectable now 50/1127 (4.4%), gate green. +- Mapping cleanup sweep (2026-07-21, 62 CSV edits + graphql manifest + rename): merged verb-named create resources into their nouns + (cloudforce_one), collapsed hash-suffixed resources (security_center + audit_logs, zero_trust cas/includes/excludes/fallback_domains), + de-duplicated workers naming (builds, versions, scripts, + scripts_settings, subdomains, invocations), folded validators/ + prechecks as exec methods (r2 slurper -> buckets, content scanning -> + settings, token_validation bulk -> rules), remapped aisearch chat + completions to SELECT (objectKey $.choices), plus cache/zones + cache_reserve tidy-up. Non-selectable now 53/1134 (4.7% - under the + 5% target), meta gate green. Heuristics captured under "Resource / + method mapping heuristics". +- AI service cleanup round 2: the 5 octet-input models folded into + `ai.run` as exec methods (CSV; data__value request blocks follow the + paths); `tomarkdown`/`to_markdown` unified into `to_markdown` + (converter, select) + `to_markdown_supported` (formats list, select) - + they cannot share one resource because both selects would have the + identical required-param signature; `ai.run` is select-only now (the + same method under insert AND select rendered duplicate doc examples). + Added `ai_docs_enhance.py` (generate-docs post-pass): supported-model + admonitions (CopyableCode per model, grouped by family on the run + page) and runnable SELECT examples (family result columns + model + input WHERE params that docgen cannot derive from + request.schema_override). ai service = 24 resources. +- Executed the non-selectable remap plan (working doc + NON_SELECTABLE_ANALYSIS.md, since deleted - final numbers in the + mapping-cleanup entry above). Three mechanisms: + 1. CSV verb/resource edits in `all_services.csv` - read-like POSTs + (d1 query, autorag/aisearch search, vectorize v2 query, traceroute, + domain-check, ssl analyze, logs SQL, billing query) remapped to + select; browser_rendering split into per-render select resources; + 24 rows folded into noun parents as exec (addressing validate + + address-map members, logpush validators, email move, queue acks, + autorag sync, vectorize v1 index update). + 2. `select_response_fixes.py` (Step 3 post-pass) + config + `provider-dev/config/select_response_fixes.yaml` - 26 response-shape + fixes: typed item schemas (ai.models/tasks), scalar-array-to-rows, + contents wraps. GOTCHA: response transforms that access `.result` + MUST be `golang_template_json_v0.3.0` (parsed input); the + `golang_template_text_v0.3.0` type receives the RAW body string and + only suits `{{ toJson . }}` whole-body wraps. + 3. `ai_task_families.py` (below). +- Added `ai_task_families.py` (Step 3 post-pass) + config + `provider-dev/config/ai_task_families.yaml`: collapsed 93 per-model + Workers AI resources into 9 task-family SELECT resources riding the + generic `/ai/run/{model_name}` op. Verified live (text_generation, + text_embeddings typed columns; text_to_image contents). +- Fixed `sanitize_docs.py` to write LF (`newline='\n'`) - on Windows it + was rewriting every touched doc page to CRLF (whole-file git churn). + Note: the generated provider yamls are CRLF in git (historical, + generated on Windows); the python passes' text-mode writes are + consistent with that. Docs are LF. +- Added `octet_stream_requests.py` (Step 3 post-pass) + + `octet_stream_docs.py` (Step 4 post-pass) for the 8 write methods with + `application/octet-stream` request bodies: naive requestBodyTranslate + dropped for those methods only, a `stackql*Body` wrapper schema exposes + a single required `value` column, and the raw body is sent verbatim. + Callers must use `data__value` for these methods; doc examples are + patched accordingly. Verified live via `npm run smoke-test-kv`. +- Added `bin/smoke-test-kv.cjs` (`npm run smoke-test-kv`): full-cycle KV + lifecycle against the live API through a local server - create + namespace, REPLACE value via `data__value`, read back and assert + round-trip, list keys, delete value, confirm gone, delete namespace. + Needs `CLOUDFLARE_ACCOUNT_ID` env + a server started with a token + carrying account-level "Workers KV Storage: Edit". - Folded 193 singleton non-SELECT resources into sibling parents (`fold_singletons.py`). - Added `binary_responses.py` post-pass to make 38 binary-download diff --git a/stackql_cloudflare/GRAPHQL.md b/stackql_cloudflare/GRAPHQL.md index b0dfa4744c3..101533523f9 100644 --- a/stackql_cloudflare/GRAPHQL.md +++ b/stackql_cloudflare/GRAPHQL.md @@ -1,93 +1,93 @@ -# GraphQL operations in the Cloudflare stackql provider - -Cloudflare's REST API does not cover every analytics surface. Several first-class endpoints are GraphQL-only - most notably the Zone Analytics API (REST `/zones/{id}/analytics/dashboard` is sunset and returns `code 1015: "Zone Analytics API is sunset and replaced by GraphQL API"`). - -The provider shims a curated set of Cloudflare GraphQL operations into the relevant service yamls. Users querying `cloudflare..` do not need to know whether dispatch is REST or GraphQL - the abstraction is transparent. - -## What's shimmed in - -| Resource | Scope | Description | Supersedes | -|---|---|---|---| -| `cloudflare.zones.http_requests_adaptive_groups` | zone | HTTP request analytics with adaptive sampling, per (minute, country, status, method) | `GET /zones/{id}/analytics/dashboard` (sunset, code 1015) | -| `cloudflare.zones.http_requests_1h_groups` | zone | Hourly HTTP request rollups (requests, bytes, cache, threats, page views, etc.) | - | -| `cloudflare.zones.http_requests_overview_adaptive_groups` | zone | HTTP request overview by (country, status, content type, browser) | `GET /zones/{id}/analytics/colos` (deprecated, EOL 2026-12-01) | -| `cloudflare.dns.dns_analytics_adaptive_groups` | zone | DNS query analytics by (query name, type, code, colo) | `GET /zones/{id}/dns_analytics/*` (deprecated, EOL 2026-12-01) | -| `cloudflare.firewall.firewall_events_adaptive_groups` | zone | Firewall event rollups by (action, source, rule, country) | - | -| `cloudflare.firewall.firewall_events` | zone | Raw firewall event stream (one row per event) | - | -| `cloudflare.workers.workers_invocations` | account | Workers invocation analytics by (script, status, colo) | - | -| `cloudflare.r2.r2_operations_adaptive_groups` | account | R2 operation analytics by (bucket, action, status) | - | -| `cloudflare.d1.d1_analytics_adaptive_groups` | account | D1 query analytics by (database, role, region) | - | -| `cloudflare.cache.cdn_network_analytics_adaptive_groups` | account | Edge L3/L4 network analytics by (colo, direction, protocol) | - | - -A wider inventory of Cloudflare's ~250 GraphQL nodes is in [GRAPHQL_OPS_INVENTORY.md](GRAPHQL_OPS_INVENTORY.md) - additions follow the same pattern (one manifest entry + one ops spec file) and can be incremental. - -## Token scope - -GraphQL Analytics requires an API token with **Account -> Analytics -> Read** permission. This is broader than the typical zone-scoped tokens you might use for REST CRUD - a zone-only token will receive a `403` from the GraphQL endpoint. - -Configure the token in `CLOUDFLARE_API_TOKEN` (the same env var the REST methods use): - -```bash -export CLOUDFLARE_API_TOKEN='' -``` - -Some account-scoped GraphQL fields are also plan-gated (e.g. `crossZoneSubrequests` requires Enterprise). The provider does not expose plan-gated fields by default - if you need them, fork the relevant op spec under `provider-dev/source-graphql/ops/` and re-merge. - -## How the protocol abstraction works - -Each GraphQL operation looks like a normal REST resource from the user's perspective: - -```sql -SHOW METHODS IN cloudflare.zones.http_requests_adaptive_groups; -DESCRIBE cloudflare.zones.http_requests_adaptive_groups; -SELECT datetime, requests, bytes FROM cloudflare.zones.http_requests_adaptive_groups -WHERE zone_tag = '...' AND since = '...' AND until = '...'; -``` - -Under the hood, each shimmed operation has: - -- A synthetic OpenAPI path key `/graphql/` with a POST verb (lets multiple GraphQL ops coexist in one service file). -- An `x-stackQL-graphQL` extension carrying the wire URL (`https://api.cloudflare.com/client/v4/graphql`), the GraphQL query template, and the response selection jsonpath. This is the any-sdk hook that routes the operation through the GraphQL acquire path instead of REST. -- A `response.transform` (golang_template_json_v0.3.0) that flattens Cloudflare's nested `dimensions / sum / count` row shape into flat snake_case columns. Users get a relational result set; they never see GraphQL. -- A `x-stackql-protocol: graphql` marker on the resource method block - used for introspection / grep and by the docgen post-pass to identify GraphQL methods. - -The protocol marker is the only externally visible hint that GraphQL is involved. - -## Example queries - -Demo `.iql` files live under [examples/analytics/](examples/analytics/). Each file is parameterised with `` or `` plus RFC3339 time bounds - substitute and run via: - -```bash -./stackql --registry="${REG}" exec -i examples/analytics/http_requests_adaptive.iql --output json -``` - -Files: - -- [http_requests_adaptive.iql](examples/analytics/http_requests_adaptive.iql) - replaces the sunset analytics dashboard endpoint. -- [dns_analytics.iql](examples/analytics/dns_analytics.iql) - DNS query rollup. -- [firewall_events.iql](examples/analytics/firewall_events.iql) - top firewall actions. -- [workers_invocations.iql](examples/analytics/workers_invocations.iql) - top Workers scripts by invocation count. - -## Caveats - -- **SELECT-only.** Cloudflare's GraphQL API has no mutations. `INSERT / UPDATE / DELETE` on these resources is not supported and will not be added (would require upstream any-sdk changes). -- **Single-page today.** Cloudflare's GraphQL pagination is filter-comparator keyset-based (not cursor-based), which does not match any-sdk's current cursor-after iteration model. All ops run as a single page bounded by the `limit` parameter (default 100). To return more rows, widen `since`/`until` or raise `limit` in the WHERE clause. Multi-page support waits on upstream any-sdk work. -- **Errors are surfaced by the transform when the response shape is unexpected.** When Cloudflare returns `{"data": null, "errors": [...]}` (auth failure, malformed query, missing permissions), the defensive transform skips the row walk and you'll see an empty result set rather than the underlying error message. Use `--http.log.enabled` to surface the processed response and inspect the raw upstream payload via curl when debugging. -- **Token scope mismatch is the most common failure mode.** A 403 from the GraphQL endpoint manifests as empty results; if rows are unexpectedly empty, verify your token has `Account -> Analytics -> Read`. - -## Adding new GraphQL operations - -Two-file change: - -1. Add an entry to [provider-dev/source-graphql/manifest.yaml](provider-dev/source-graphql/manifest.yaml): - ```yaml - - field: yourGraphQLFieldName - scope: zone # or account - service: # must match an existing provider-dev/openapi/.../services/.yaml - resource: - method: list - spec: ops/.yaml - ``` -2. Create the spec file at `provider-dev/source-graphql/ops/.yaml` mirroring the shape of existing specs. Required keys: `description`, `parameters`, `query` (template), `transform` (with the defensive null-guard pattern), `row_schema`. - -Re-run `npm run generate-provider` (or just the post-pass: `python -m stackql_cloudflare_provider.graphql_merge`) to shim the new op into the matching service yaml. The merge is idempotent. +# GraphQL operations in the Cloudflare stackql provider + +Cloudflare's REST API does not cover every analytics surface. Several first-class endpoints are GraphQL-only - most notably the Zone Analytics API (REST `/zones/{id}/analytics/dashboard` is sunset and returns `code 1015: "Zone Analytics API is sunset and replaced by GraphQL API"`). + +The provider shims a curated set of Cloudflare GraphQL operations into the relevant service yamls. Users querying `cloudflare..` do not need to know whether dispatch is REST or GraphQL - the abstraction is transparent. + +## What's shimmed in + +| Resource | Scope | Description | Supersedes | +|---|---|---|---| +| `cloudflare.zones.http_requests_adaptive_groups` | zone | HTTP request analytics with adaptive sampling, per (minute, country, status, method) | `GET /zones/{id}/analytics/dashboard` (sunset, code 1015) | +| `cloudflare.zones.http_requests_1h_groups` | zone | Hourly HTTP request rollups (requests, bytes, cache, threats, page views, etc.) | - | +| `cloudflare.zones.http_requests_overview_adaptive_groups` | zone | HTTP request overview by (country, status, content type, browser) | `GET /zones/{id}/analytics/colos` (deprecated, EOL 2026-12-01) | +| `cloudflare.dns.analytics_adaptive_groups` | zone | DNS query analytics by (query name, type, code, colo) | `GET /zones/{id}/dns_analytics/*` (deprecated, EOL 2026-12-01) | +| `cloudflare.firewall.firewall_events_adaptive_groups` | zone | Firewall event rollups by (action, source, rule, country) | - | +| `cloudflare.firewall.firewall_events` | zone | Raw firewall event stream (one row per event) | - | +| `cloudflare.workers.invocations` | account | Workers invocation analytics by (script, status, colo) | - | +| `cloudflare.r2.operations_adaptive_groups` | account | R2 operation analytics by (bucket, action, status) | - | +| `cloudflare.d1.analytics_adaptive_groups` | account | D1 query analytics by (database, role, region) | - | +| `cloudflare.cache.cdn_network_analytics_adaptive_groups` | account | Edge L3/L4 network analytics by (colo, direction, protocol) | - | + +A wider inventory of Cloudflare's ~250 GraphQL nodes is in [GRAPHQL_OPS_INVENTORY.md](GRAPHQL_OPS_INVENTORY.md) - additions follow the same pattern (one manifest entry + one ops spec file) and can be incremental. + +## Token scope + +GraphQL Analytics requires an API token with **Account -> Analytics -> Read** permission. This is broader than the typical zone-scoped tokens you might use for REST CRUD - a zone-only token will receive a `403` from the GraphQL endpoint. + +Configure the token in `CLOUDFLARE_API_TOKEN` (the same env var the REST methods use): + +```bash +export CLOUDFLARE_API_TOKEN='' +``` + +Some account-scoped GraphQL fields are also plan-gated (e.g. `crossZoneSubrequests` requires Enterprise). The provider does not expose plan-gated fields by default - if you need them, fork the relevant op spec under `provider-dev/source-graphql/ops/` and re-merge. + +## How the protocol abstraction works + +Each GraphQL operation looks like a normal REST resource from the user's perspective: + +```sql +SHOW METHODS IN cloudflare.zones.http_requests_adaptive_groups; +DESCRIBE cloudflare.zones.http_requests_adaptive_groups; +SELECT datetime, requests, bytes FROM cloudflare.zones.http_requests_adaptive_groups +WHERE zone_tag = '...' AND since = '...' AND until = '...'; +``` + +Under the hood, each shimmed operation has: + +- A synthetic OpenAPI path key `/graphql/` with a POST verb (lets multiple GraphQL ops coexist in one service file). +- An `x-stackQL-graphQL` extension carrying the wire URL (`https://api.cloudflare.com/client/v4/graphql`), the GraphQL query template, and the response selection jsonpath. This is the any-sdk hook that routes the operation through the GraphQL acquire path instead of REST. +- A `response.transform` (golang_template_json_v0.3.0) that flattens Cloudflare's nested `dimensions / sum / count` row shape into flat snake_case columns. Users get a relational result set; they never see GraphQL. +- A `x-stackql-protocol: graphql` marker on the resource method block - used for introspection / grep and by the docgen post-pass to identify GraphQL methods. + +The protocol marker is the only externally visible hint that GraphQL is involved. + +## Example queries + +Demo `.iql` files live under [examples/analytics/](examples/analytics/). Each file is parameterised with `` or `` plus RFC3339 time bounds - substitute and run via: + +```bash +./stackql --registry="${REG}" exec -i examples/analytics/http_requests_adaptive.iql --output json +``` + +Files: + +- [http_requests_adaptive.iql](examples/analytics/http_requests_adaptive.iql) - replaces the sunset analytics dashboard endpoint. +- [dns_analytics.iql](examples/analytics/dns_analytics.iql) - DNS query rollup. +- [firewall_events.iql](examples/analytics/firewall_events.iql) - top firewall actions. +- [workers_invocations.iql](examples/analytics/workers_invocations.iql) - top Workers scripts by invocation count. + +## Caveats + +- **SELECT-only.** Cloudflare's GraphQL API has no mutations. `INSERT / UPDATE / DELETE` on these resources is not supported and will not be added (would require upstream any-sdk changes). +- **Single-page today.** Cloudflare's GraphQL pagination is filter-comparator keyset-based (not cursor-based), which does not match any-sdk's current cursor-after iteration model. All ops run as a single page bounded by the `limit` parameter (default 100). To return more rows, widen `since`/`until` or raise `limit` in the WHERE clause. Multi-page support waits on upstream any-sdk work. +- **Errors are surfaced by the transform when the response shape is unexpected.** When Cloudflare returns `{"data": null, "errors": [...]}` (auth failure, malformed query, missing permissions), the defensive transform skips the row walk and you'll see an empty result set rather than the underlying error message. Use `--http.log.enabled` to surface the processed response and inspect the raw upstream payload via curl when debugging. +- **Token scope mismatch is the most common failure mode.** A 403 from the GraphQL endpoint manifests as empty results; if rows are unexpectedly empty, verify your token has `Account -> Analytics -> Read`. + +## Adding new GraphQL operations + +Two-file change: + +1. Add an entry to [provider-dev/source-graphql/manifest.yaml](provider-dev/source-graphql/manifest.yaml): + ```yaml + - field: yourGraphQLFieldName + scope: zone # or account + service: # must match an existing provider-dev/openapi/.../services/.yaml + resource: + method: list + spec: ops/.yaml + ``` +2. Create the spec file at `provider-dev/source-graphql/ops/.yaml` mirroring the shape of existing specs. Required keys: `description`, `parameters`, `query` (template), `transform` (with the defensive null-guard pattern), `row_schema`. + +Re-run `npm run generate-provider` (or just the post-pass: `python -m stackql_cloudflare_provider.graphql_merge`) to shim the new op into the matching service yaml. The merge is idempotent. diff --git a/stackql_cloudflare/Makefile b/stackql_cloudflare/Makefile new file mode 100644 index 00000000000..e90ca208cbe --- /dev/null +++ b/stackql_cloudflare/Makefile @@ -0,0 +1,90 @@ +# StackQL Cloudflare provider - build pipeline. +# +# `make all` runs the full generate -> gate -> docs chain: +# +# specs Step 1: download/transform upstream OpenAPI into per-service +# yamls under provider-dev/source/ (uses the cached download; +# use `make specs-refresh` to re-pull the upstream spec) +# mappings Step 2: refresh provider-dev/config/all_services.csv in +# --strict mode - FAILS if any operation has no existing +# mapping row. Default rows are still written for the new +# operations; review/curate them in the CSV, then re-run. +# provider Step 3: generate the provider tree + ALL post-passes +# (strip_superseded_rest, binary_responses, +# request_body_transforms, octet_stream_requests, +# ai_task_families, select_response_fixes, graphql_merge - +# wired inside bin/generate-provider.mjs) +# meta-test Step 4 gate (go/no-go): start a local server, walk every +# SHOW/DESCRIBE meta route, stop the server. Non-zero exit +# stops the build. No API token needed. +# docs Step 6: generate Docusaurus markdown + post-passes +# (sanitize_docs, octet_stream_docs, ai_docs_enhance - +# wired inside bin/generate-docs.mjs) +# +# Live smoke tests are deliberately NOT part of `all` (they hit +# api.cloudflare.com and need credentials). Run them separately: +# +# export CLOUDFLARE_API_TOKEN=... # account-level "Workers KV Storage:Edit" +# export CLOUDFLARE_ACCOUNT_ID=... +# make smoke-test-kv +# +# Run from Linux, macOS, or WSL (server lifecycle scripts need a POSIX +# shell with pgrep/ps). + +SHELL := /bin/bash +# python on Windows/Git Bash, python3 on WSL/Linux/macOS - override with PYTHON=... +PYTHON ?= $(shell command -v python >/dev/null 2>&1 && echo python || echo python3) +PORT ?= 5444 + +.PHONY: all specs specs-refresh mappings provider meta-test docs smoke-test-kv start-server stop-server help + +all: specs mappings provider meta-test docs + @echo "" + @echo "make all complete: provider + docs generated, meta-route gate passed." + @echo "Live smoke tests are run separately - see 'make help'." + +help: + @echo "Targets:" + @echo " all specs -> mappings -> provider -> meta-test -> docs" + @echo " specs Step 1: upstream OpenAPI -> provider-dev/source/*.yaml (cached download)" + @echo " specs-refresh Step 1 with --refresh: re-download the upstream spec first" + @echo " mappings Step 2: refresh all_services.csv (--strict: fails on unmapped operations)" + @echo " provider Step 3: generate provider + all post-gen passes (binary/octet/AI families/response fixes/graphql)" + @echo " meta-test Step 4 gate: SHOW/DESCRIBE walk via local server (no token needed)" + @echo " docs Step 6: generate docs + sanitize/octet-example/AI-page post-passes" + @echo " smoke-test-kv Live full-cycle KV test - needs CLOUDFLARE_API_TOKEN + CLOUDFLARE_ACCOUNT_ID" + @echo " start-server / stop-server Local stackql server lifecycle (PORT=$(PORT))" + +specs: + $(PYTHON) -m stackql_cloudflare_provider.generate_specs --clean + +specs-refresh: + $(PYTHON) -m stackql_cloudflare_provider.generate_specs --refresh --clean + +mappings: + $(PYTHON) -m stackql_cloudflare_provider.assign_resource_names --strict + +provider: + npm run generate-provider + +# Go/no-go gate: the server is always torn down, and the meta-test's +# exit status is preserved so a failure stops `make all`. +meta-test: + bash bin/start-server.sh --port $(PORT) + node bin/test-meta-routes.cjs cloudflare --port $(PORT); status=$$?; bash bin/stop-server.sh --port $(PORT); exit $$status + +docs: + npm run generate-docs + +# Live smoke test - NOT part of `all`. Requires: +# CLOUDFLARE_API_TOKEN token with account-level "Workers KV Storage:Edit" +# CLOUDFLARE_ACCOUNT_ID target account (or pass --account via ARGS) +smoke-test-kv: + bash bin/start-server.sh --port $(PORT) + node bin/smoke-test-kv.cjs --port $(PORT) $(ARGS); status=$$?; bash bin/stop-server.sh --port $(PORT); exit $$status + +start-server: + bash bin/start-server.sh --port $(PORT) + +stop-server: + bash bin/stop-server.sh --port $(PORT) diff --git a/stackql_cloudflare/README.md b/stackql_cloudflare/README.md index 0b8b1fa86f8..3901305bb56 100644 --- a/stackql_cloudflare/README.md +++ b/stackql_cloudflare/README.md @@ -4,85 +4,79 @@ This directory contains the tooling and source artefacts needed to generate the The service hierarchy mirrors the Python SDK's `src/cloudflare/resources/` layout (109+ services such as `zones`, `dns`, `workers`, `zero_trust`, `accounts`). +## Quick start - make all + +The whole generate -> test -> docs chain is wrapped in a `Makefile`. Run from the `stackql_cloudflare/` directory on Linux, macOS, or WSL (the server lifecycle scripts need a POSIX shell with `pgrep`/`ps`). + +One-time setup (Python 3.10+, Node 18+; the Cloudflare Python SDK source must be present in the parent `src/cloudflare/` directory, which it is in this repo): + +```bash +pip install pyyaml +npm install # .npmrc configures the JSR registry needed by a transitive dep +``` + +Then: + +```bash +make all +``` + +`make all` runs the following targets in order, stopping on the first failure: + +| Target | Step | Wraps | Description | +| ----------- | ---- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `specs` | 1 | `npm run generate-specs -- --clean` | Upstream OpenAPI -> `provider-dev/source/*.yaml` (cached download; `make specs-refresh` re-pulls the spec first). | +| `mappings` | 2 | `assign_resource_names --strict` | Refresh `all_services.csv`. **Fails if any operation has no existing mapping row** - curate the defaulted rows, re-run. | +| `provider` | 3 | `npm run generate-provider` | Generate the provider tree plus all post-gen passes. | +| `meta-test` | 4 | `start-server` -> `test-meta-routes` -> `stop-server` | Go/no-go gate: walk every SHOW/DESCRIBE meta route. Non-zero exit stops the build. No API token needed. | +| `docs` | 6 | `npm run generate-docs` | Generate Docusaurus markdown plus the sanitize, octet-stream example, and AI page enhancement post-passes. | + +Live smoke tests are deliberately NOT part of `make all` - they execute against `api.cloudflare.com` and need credentials. Run them separately after `make all` passes: + +```bash +export CLOUDFLARE_API_TOKEN=... # account-level "Workers KV Storage:Edit" +export CLOUDFLARE_ACCOUNT_ID=... +make smoke-test-kv # wraps server start -> bin/smoke-test-kv.cjs -> server stop +``` + +Step 5 (manual live UAT + smoke tests) and step 7 (publish PRs) remain human-driven so the gates can actually do their job. `make help` lists every target; each can be run individually (`make provider`, `make meta-test`, ...). + ## Table of contents -- [Layout](#layout) - directory + file tour of the generator + outputs. -- [Prerequisites](#prerequisites) - Python, Node, SDK checkout. -- [End-to-end - path to production](#end-to-end---path-to-production) - the 7-step pipeline (table below). -- [One-liner](#one-liner) - codegen-only chain for steps 1-3. +- [Quick start - make all](#quick-start---make-all) +- [Pipeline steps](#pipeline-steps) + - [Step 1 - Generate OpenAPI specs](#step-1---generate_openapi_specs) (`make specs`) + - [Step 2 - Assign resource names](#step-2---assign_resource_names) (`make mappings`) + - [Step 3 - Generate provider](#step-3---generate_provider) (`make provider`) + - [Step 4 - Meta route test](#step-4---meta_route_test) (`make meta-test`) + - [Step 5 - Live smoke / UAT](#step-5---live_smoke_uat) (manual + `make smoke-test-kv`) + - [Step 6 - Generate web docs](#step-6---generate_webdocs) (`make docs`) + - [Step 7a - Publish provider](#step-7a---publish_provider-stackql-provider-registry) (manual PR flow) + - [Step 7b - Publish docs](#step-7b---publish_docs-netlify) (manual PR flow) - [Analytics resources](#analytics-resources) - notes on the 10 GraphQL-backed analytics resources. - [Updating to a new upstream spec](#updating-to-a-new-upstream-spec) - what to do when Cloudflare bumps the SDK. - [Design notes](#design-notes) - the "why" behind the non-obvious decisions. - [Addendum - upstream sync + regeneration](#addendum---upstream-sync--regeneration) - syncing this fork from `cloudflare/cloudflare-python`, plus the `gh` workflow that sidesteps the fork-network PR enumeration. -## Layout - -``` -stackql_cloudflare/ -├── stackql_cloudflare_provider/ # Python package - spec generation -│ ├── generate_specs.py # Step 1: pull upstream OpenAPI, normalize, split per service -│ ├── assign_resource_names.py # Step 2: write/update all_services.csv -│ ├── binary_responses.py # Step 3 post-pass: wrap non-JSON responses (PDFs, images, raw text) with a `contents` column transform -│ ├── sanitize_docs.py # Step 4 post-pass: scrub MDX-hostile chars + rewrite Cloudflare-relative links -│ ├── sdk_index.py # Walks src/cloudflare/resources/ -> (verb, path) -> service map -│ ├── split.py # Service splitter + path -> service resolver -│ ├── fanout.py # Explode dual-scope /{accounts_or_zones}/... paths -│ ├── rename.py # Schema -> camelCase + path params -> snake_case -│ ├── canonical_params.py # Standardise common path-param definitions (account_id, zone_id, ...) -│ ├── normalize.py # Schema normalizer (kills allOf/oneOf/anyOf/additionalProperties) -│ └── fold_singletons.py # One-shot CSV mutation: fold singleton non-SELECT resources into sibling parents as exec methods -├── bin/ -│ ├── generate-provider.mjs # Step 3: provider-utils.generate wrapper -│ ├── generate-docs.mjs # Step 4: provider-utils.generateDocs wrapper -│ ├── start-server.sh # Starts a local stackql server against the generated registry -│ ├── stop-server.sh -│ ├── server-status.sh -│ └── test-meta-routes.cjs # Smoke-test all SHOW/DESCRIBE routes -├── provider-dev/ -│ ├── downloads/ # Cached upstream OpenAPI spec (~17 MB) -│ ├── source/ # Per-service yamls (step 1 output) -│ ├── config/all_services.csv # Resource/method/verb assignments (step 2 output) -│ ├── docgen/provider-data/ # headerContent1.txt + headerContent2.txt for the website -│ └── openapi/src/cloudflare/v00.00.00000/ # Final provider (step 3 output) -└── website/docs/ # Docusaurus markdown (step 4 output) -``` - -## Prerequisites - -- Python 3.10+ - ```bash - pip install pyyaml - ``` -- Node.js 18+ - ```bash - npm install - ``` - (The `.npmrc` configures the JSR registry needed by a transitive dep.) -- The Cloudflare Python SDK source must be present in the parent `src/cloudflare/` directory of this repository (it already is in this repo). +## Pipeline steps -## End-to-end - path to production +The pipeline is seven steps: four code-generation steps (1, 2, 3, 6), two test/UAT gates (4, 5), and a final publish stage with two independent sub-targets (7a provider registry, 7b docs microsite). Each step is idempotent and can be re-run as the upstream spec evolves. Steps 1-4 and 6 are automated end-to-end by [`make all`](#quick-start---make-all). -Run from the directory `stackql_cloudflare/`. The pipeline is seven steps: four code-generation steps (1, 2, 3, 6), two test/UAT gates (4, 5), and a final publish stage with two independent sub-targets (7a provider registry, 7b docs microsite). Each step is idempotent and can be re-run as the upstream spec evolves. +### Step 1 - GENERATE_OPENAPI_SPECS -| # | Summary | Description | -| -- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1 | [OpenAPI gen](#step-1---generate_openapi_specs) | Download upstream Cloudflare OpenAPI, normalize polymorphism, split into per-service yamls under `provider-dev/source/`. | -| 2 | [Route assignment](#step-2---assign_resource_names) | Walk the source yamls and write/refresh `provider-dev/config/all_services.csv` mapping every operation to a stackql resource / method / verb / object key. | -| 3 | [Provider gen](#step-3---generate_provider) | Run `@stackql/provider-utils` to emit the final provider tree (`provider.yaml` + per-service yamls with `x-stackQL-resources` blocks). | -| 4 | [Meta route test](#step-4---meta_route_test) | Start local stackql server and walk every `SHOW METHODS / DESCRIBE` route - catches spec issues that only surface at SQL plan time. No API token needed. | -| 5 | [Live smoke / UAT](#step-5---live_smoke_uat) | Open `stackql shell` against the local registry, export `CLOUDFLARE_API_TOKEN`, run the canned UAT queries to confirm real API calls succeed. | -| 6 | [Doc gen + pre-flight](#step-6---generate_webdocs) | Generate Docusaurus markdown under `website/docs/`, then `yarn build` + `yarn serve` from `website/` to confirm the site compiles and pages look right. | -| 7a | [Publish provider](#step-7a---publish_provider-stackql-provider-registry) | Copy the generated provider tree to `stackql-provider-registry/providers/src/cloudflare/`, PR to `dev`, smoke-test against `registry-dev.stackql.app`, then PR `dev` -> `main` to promote to the prod registry. | -| 7b | [Publish docs](#step-7b---publish_docs-netlify) | PR to `main` in this repo - Netlify builds a preview deploy on the PR; merging publishes to `https://cloudflare-provider.stackql.io/`. | +Download the upstream Cloudflare OpenAPI spec, normalize polymorphism, and split it into per-service yamls under `provider-dev/source/`. -### Step 1 - GENERATE_OPENAPI_SPECS +```bash +make specs # or: make specs-refresh (re-downloads the upstream spec first) +``` + +Underlying command: ```bash npm run generate-specs -- --clean +# = python -m stackql_cloudflare_provider.generate_specs --clean ``` -(equivalent to `python -m stackql_cloudflare_provider.generate_specs --clean`) - This: 1. Downloads the upstream Cloudflare OpenAPI spec (URL is sourced from the repo-root `.stats.yml`) and caches it under `provider-dev/downloads/`. @@ -102,11 +96,19 @@ Flags: ### Step 2 - ASSIGN_RESOURCE_NAMES +Walk the source yamls and write/refresh `provider-dev/config/all_services.csv`, mapping every operation to a stackql resource / method / verb / object key. + ```bash -npm run assign-resource-names +make mappings # runs with --strict: fails on any unmapped operation ``` -(equivalent to `python -m stackql_cloudflare_provider.assign_resource_names`) +Underlying command: + +```bash +npm run assign-resource-names +# = python -m stackql_cloudflare_provider.assign_resource_names +# make adds --strict (see below) +``` Walks every `provider-dev/source/*.yaml` and ensures every operation has a row in `provider-dev/config/all_services.csv` with sensible default StackQL resource/method/verb/object_key values. @@ -125,6 +127,8 @@ On subsequent runs (e.g. after refreshing the upstream spec): Use `--reset` to discard all user edits and re-default the entire CSV from scratch (rare; useful only when the defaulter logic itself has changed and you want to re-baseline). +Use `--strict` (what `make mappings` runs) to turn "new op found" into a hard failure: the command exits non-zero if any operation had no existing mapping row, or if any row carries a hash-suffixed resource/method name (the collision-disambiguation fallback - never an acceptable end state). The default rows ARE still written, so the workflow is: review the new rows in the CSV, tighten resource/method/verb where the defaults are wrong, rename any hashed names semantically, and re-run. + CSV columns: | Column | Purpose | @@ -164,8 +168,17 @@ Flags: ### Step 3 - GENERATE_PROVIDER +Run `@stackql/provider-utils` to emit the final provider tree (`provider.yaml` + per-service yamls with `x-stackQL-resources` blocks), then apply all post-gen passes. + +```bash +make provider +``` + +Underlying command: + ```bash npm run generate-provider +# = node ./bin/generate-provider.mjs (plus the post-passes listed below) ``` Wraps `@stackql/provider-utils` `providerdev.generate`. Reads `provider-dev/source/` plus the CSV mapping and writes the StackQL provider tree to: @@ -187,11 +200,25 @@ Provider config injected: When multiple HTTP operations are exposed under the same SQL verb (e.g. `SELECT` can dispatch to either `get` on `/zones/{zone_id}` or `list` on `/zones`), `provider-utils.generate` sorts each `sqlVerbs.` list by required path-param count descending so the most-specific method is picked first. That's sufficient for the Cloudflare API - no extra sort step is needed. +`generate-provider` then runs five post-passes automatically (each is idempotent and can also be run standalone via `python -m stackql_cloudflare_provider.`): + +1. `binary_responses` - wraps non-JSON success responses (PDFs, images, raw text, octet-stream) into a `{contents: string}` shape with a `response.transform`, so binary-download endpoints are SELECT-able as a `contents` column. +2. `request_body_transforms` - attaches a `request.transform` to write methods whose JSON body has array/object properties (the naive translator would string-wrap them on the wire). +3. `octet_stream_requests` - rewrites the handful of write methods whose request body is `application/octet-stream` (KV value PUT, Workers AI binary-input models, DLP dataset uploads). For these methods ONLY, the naive `requestBodyTranslate` is dropped; an injected `stackql*Body` wrapper schema exposes a single required `value` column via `request.schema_override`, and a `request.transform` sends it verbatim as the raw body. Callers MUST use the `data__` prefix for these methods, e.g. `REPLACE cloudflare.kv.values SET data__value = '...' WHERE ...`. +4. `ai_task_families` - collapses the ~93 per-model Workers AI run resources into 9 task-family SELECT resources (`ai.text_generation`, `ai.text_embeddings`, `ai.text_to_image`, ...) riding the generic `POST /ai/run/{model_name}` operation with `model_name` as the discriminator. WHERE params bind to body properties with unprefixed names (`WHERE model_name = '@cf/meta/llama-3.2-1b-instruct' AND prompt = '...'`), and each SELECT executes (and bills) an inference call. Config: `provider-dev/config/ai_task_families.yaml`. The generic `ai.run` resource remains as the select-only escape hatch for unlisted models, and also carries the 5 octet-stream-input models (whisper x2, resnet x2, detr) as exec methods with the `data__value` raw-body path (folded via `all_services.csv` - binary input cannot be a SELECT WHERE param). +5. `select_response_fixes` - fixes response shapes for resources whose SELECT would return no columns (untyped `result.items`, scalar arrays, raw text bodies, dynamic objects): typed item schemas for the ai model catalog, scalar-array-to-rows transforms, and `contents` wraps. Config: `provider-dev/config/select_response_fixes.yaml`. + +(A final post-pass, `graphql_merge`, shims the hand-authored GraphQL operations from `provider-dev/source-graphql/` into the matching service yamls.) + ### Step 4 - META_ROUTE_TEST -Start a local stackql server backed by the freshly-built registry, then walk every documented service / resource through `SHOW METHODS / DESCRIBE`. Surfaces spec issues that only show up at SQL plan time. +Go/no-go gate. Start a local stackql server backed by the freshly-built registry, then walk every documented service / resource through `SHOW METHODS / DESCRIBE`. Surfaces spec issues that only show up at SQL plan time. -Run from Linux, macOS, or WSL (the bash scripts assume `pgrep` / `ps` and a POSIX shell): +```bash +make meta-test # server start -> test -> server stop, exit status preserved +``` + +Underlying commands (run from Linux, macOS, or WSL - the bash scripts assume `pgrep` / `ps` and a POSIX shell): ```bash npm run start-server # Starts stackql on tcp/5444 with this registry mounted @@ -204,7 +231,9 @@ Step 4 does NOT need a Cloudflare API token - meta routes are answered from the ### Step 5 - LIVE_SMOKE_UAT -Manual. Confirms the generated provider actually executes against `api.cloudflare.com`. Requires a Cloudflare API token scoped to whatever endpoints you want to hit (the four canned queries below need `Account Settings:Read`, `Zone:Read`, `Pages:Read`, `Workers Scripts:Read`). +Confirms the generated provider actually executes against `api.cloudflare.com`. Deliberately NOT part of `make all` - it needs live credentials. Two parts: the manual UAT queries below, and the automated full-cycle KV smoke test (`make smoke-test-kv`). + +The manual part requires a Cloudflare API token scoped to whatever endpoints you want to hit (the four canned queries below need `Account Settings:Read`, `Zone:Read`, `Pages:Read`, `Workers Scripts:Read`). ```bash export CLOUDFLARE_API_TOKEN=... @@ -248,10 +277,39 @@ SELECT id, name FROM cloudflare.workers.workers WHERE account_id = ' test -> server stop +``` + +Or with the server lifecycle managed by hand: + +```bash +npm run start-server +npm run smoke-test-kv +npm run stop-server +``` + +The token needs account-level `Workers KV Storage:Edit`. The test creates a scratch namespace (`stackql-smoke-`), REPLACEs a value via `data__value`, reads it back and asserts the round-trip, lists keys, deletes the value, confirms it is gone, and deletes the namespace (cleanup runs even on failure; `--keep` skips it). Non-zero exit on any failure. + ### Step 6 - GENERATE_WEBDOCS +Generate Docusaurus markdown under `website/docs/` plus three post-passes (MDX sanitize, octet-stream `data__` examples, Workers AI page enhancement), then build and eyeball the site locally before raising the docs PR. + +```bash +make docs +``` + +Underlying command: + ```bash npm run generate-docs +# = node ./bin/generate-docs.mjs (plus the post-passes listed below) ``` Wraps `@stackql/provider-utils` `docgen.generateDocs` and emits Docusaurus markdown under `website/docs/`. Header content for the provider landing page comes from `provider-dev/docgen/provider-data/headerContent{1,2}.txt`. @@ -272,6 +330,16 @@ Re-run the sanitiser by itself any time you edit the generated markdown by hand: python -m stackql_cloudflare_provider.sanitize_docs --verbose ``` +A second post-step then runs automatically: + +```bash +python -m stackql_cloudflare_provider.octet_stream_docs +``` + +This finds every resource method carrying `request.mediaType: application/octet-stream` in the generated provider yamls (attached by the `octet_stream_requests` post-pass in step 3, so the two can't drift) and rewrites that method's SQL example on the matching docs page to show the body column `data__`-prefixed (`SET data__value = '{{ value }}'`, or `data__value` first in the INSERT column list). Naive body translation is off for those methods, so the unprefixed form docgen emits would not execute. Only the matched method's sql block is touched. Idempotent. + +A third post-step, `ai_docs_enhance`, then rewrites the Workers AI task-family pages plus the generic `run` page: a `Supported models` admonition listing every valid `model_name` as copyable code (grouped by family on the run page), and runnable SELECT examples with the family's typed result columns and the model input WHERE params (prompt, text, audio, ...) that docgen cannot derive from `request.schema_override`. Driven by `provider-dev/config/ai_task_families.yaml`. Idempotent. + #### Pre-flight - build and serve the site locally Before opening the docs PR (step 7b) you should compile the site and eyeball it. These are NOT wired into `generate-docs` - run them after by hand. They catch (a) MDX/markdown errors that would fail the Netlify build and (b) visually-broken pages that pass the build but read wrong: @@ -341,31 +409,19 @@ The docs microsite at `https://cloudflare-provider.stackql.io/` is built by Netl Steps 7a and 7b are independent and can be raised in either order - the provider works without the docs, and the docs work against either the dev or prod registry. -## One-liner - -The first three steps (pure codegen, no I/O against external systems) can be chained: - -```bash -npm run generate-specs -- --clean \ - && npm run assign-resource-names \ - && npm run generate-provider -``` - -Steps 4-7 should be run individually so the gates (meta route test, live UAT, docs pre-flight, PR reviews) can actually do their job. - ## Analytics resources The provider exposes a curated set of 10 analytics resources covering HTTP request rollups, DNS query analytics, firewall events, Workers invocations, R2 / D1 / CDN-network metrics, and more. They require a broader API token scope than the typical REST endpoints (`Account -> Analytics -> Read`) and take a mandatory `since` / `until` time window. Example queries are in [examples/analytics/](examples/analytics/); maintainer-facing detail on the underlying dispatch is in [GRAPHQL.md](GRAPHQL.md). ## Updating to a new upstream spec -When the Cloudflare Python SDK is bumped, walk the full 7-step path-to-production above with two adjustments at the front end: +When the Cloudflare Python SDK is bumped, walk the full 7-step [pipeline](#pipeline-steps) above with two adjustments at the front end: 1. `git pull` the new SDK into `src/cloudflare/` (the parent repo). -2. Run step 1 with `--refresh` to re-download the upstream OpenAPI: `npm run generate-specs -- --refresh --clean`. -3. Run step 2: `npm run assign-resource-names` - preserves your manual CSV edits and logs any newly-discovered operations so you can spot-check them. -4. Review the diff in `provider-dev/source/` and `provider-dev/config/all_services.csv` before proceeding. -5. Continue with steps 3-7 (provider gen -> meta route test -> live UAT -> doc gen + pre-flight -> publish provider + docs). +2. Run step 1 with `--refresh` to re-download the upstream OpenAPI: `make specs-refresh` (or `npm run generate-specs -- --refresh --clean`). +3. Run step 2: `make mappings` - preserves your manual CSV edits and fails on any newly-discovered operation so you can curate the auto-defaulted rows before proceeding. +4. Review the diff in `provider-dev/source/` and `provider-dev/config/all_services.csv`, then re-run `make all` (skips nothing - specs are regenerated from the now-refreshed cache and the strict gate re-checks the CSV). +5. Continue with steps 5-7 (live UAT + smoke tests -> docs pre-flight -> publish provider + docs). ## Design notes @@ -433,6 +489,8 @@ git push origin main That's it. No GitHub UI dance needed. If the `--ff-only` merge fails (rare - means Stainless force-pushed upstream `main`, or you've committed to `main` locally by mistake), investigate before reaching for `--no-ff` or `reset --hard`. +Note on CI: every job in the inherited Stainless workflows (`.github/workflows/` - ci, detect-breaking-changes, release-doctor, semgrep, sync-labels, publish-pypi) is guarded with `if: github.repository == 'cloudflare/cloudflare-python'`, so they all skip instantly on this fork's PRs and pushes. After an upstream sync, re-check the workflows: upstream edits to those files may conflict with the guard lines (keep the guard), and any NEW workflow upstream adds needs the same guard added to its jobs. + (`gh repo sync stackql-registry/stackql-provider-cloudflare --branch main` is a thin wrapper around the same fetch/merge if you prefer it.) Cadence: typically quarterly, or whenever an upstream Cloudflare feature you want to expose lands in the SDK. There's no automated trigger - skim the upstream changelog and bump when relevant. @@ -449,7 +507,7 @@ git merge main # Resolve any conflicts - typically only .stats.yml and src/cloudflare/ touch points; stackql_cloudflare/ should be conflict-free unless you've hand-edited generated artefacts. ``` -Then run steps 1-6 of the [path-to-production pipeline](#end-to-end---path-to-production) on the feature branch. Step 2 (`assign-resource-names`) logs every newly-discovered upstream operation; skim that log and tighten the CSV defaults if any new row landed on the wrong stackql resource / method / verb. See [Updating to a new upstream spec](#updating-to-a-new-upstream-spec) for the short form. +Then run steps 1-6 of the [pipeline](#pipeline-steps) on the feature branch (`make all` covers steps 1-4 and 6). Step 2 (`make mappings`) fails on every newly-discovered upstream operation; curate the auto-defaulted CSV rows if any landed on the wrong stackql resource / method / verb, then re-run. See [Updating to a new upstream spec](#updating-to-a-new-upstream-spec) for the short form. ### Raising the PR back to `stackql-provider` @@ -477,4 +535,4 @@ git config alias.pr-url '!f() { echo "https://github.com/stackql-registry/stackq git pr-url # prints the URL to click ``` -Once the upstream-sync PR merges into `stackql-provider`, continue with step 7 of the path-to-production pipeline (publish provider + docs). +Once the upstream-sync PR merges into `stackql-provider`, continue with step 7 of the [pipeline](#pipeline-steps) (publish provider + docs). diff --git a/stackql_cloudflare/bin/generate-docs.mjs b/stackql_cloudflare/bin/generate-docs.mjs index 653a04e6143..baf1da49da5 100644 --- a/stackql_cloudflare/bin/generate-docs.mjs +++ b/stackql_cloudflare/bin/generate-docs.mjs @@ -59,3 +59,32 @@ if (sanitize.status !== 0) { console.error(`[generate-docs] sanitize_docs failed with exit ${sanitize.status}`); process.exit(sanitize.status ?? 1); } + +// Post-process: rewrite SQL examples for methods whose request body is +// application/octet-stream (discovered from the provider yamls' request +// blocks - see octet_stream_requests.py). Naive requestBodyTranslate is +// off for those methods, so body columns MUST be data__-prefixed; docgen +// renders them unprefixed or omits them, so we patch the examples here. +console.log(`[generate-docs] rewriting octet-stream request body examples with data__ prefixes...`); +const octetDocs = spawnSync(pythonBin, ['-m', 'stackql_cloudflare_provider.octet_stream_docs'], { + cwd: BASE_DIR, + stdio: 'inherit', +}); +if (octetDocs.status !== 0) { + console.error(`[generate-docs] octet_stream_docs failed with exit ${octetDocs.status}`); + process.exit(octetDocs.status ?? 1); +} + +// Post-process: enhance the Workers AI task-family pages + the generic +// run page - supported-model admonitions (copyable model names) and +// runnable SELECT examples with the model input WHERE params docgen +// can't derive from request.schema_override. +console.log(`[generate-docs] enhancing Workers AI family doc pages...`); +const aiDocs = spawnSync(pythonBin, ['-m', 'stackql_cloudflare_provider.ai_docs_enhance'], { + cwd: BASE_DIR, + stdio: 'inherit', +}); +if (aiDocs.status !== 0) { + console.error(`[generate-docs] ai_docs_enhance failed with exit ${aiDocs.status}`); + process.exit(aiDocs.status ?? 1); +} diff --git a/stackql_cloudflare/bin/generate-provider.mjs b/stackql_cloudflare/bin/generate-provider.mjs index 1504a05e969..2934969dd8b 100644 --- a/stackql_cloudflare/bin/generate-provider.mjs +++ b/stackql_cloudflare/bin/generate-provider.mjs @@ -133,6 +133,51 @@ if (reqtx.status !== 0) { process.exit(reqtx.status ?? 1); } +// Post-process: rewrite methods whose request body is application/ +// octet-stream (KV value PUT, Workers AI binary-input models, DLP +// dataset uploads). Naive requestBodyTranslate is dropped for these +// methods ONLY; a synthetic stackql*Body wrapper schema presents a +// single required `value` column and a request.transform splats it +// verbatim onto the wire as the raw body. Callers must use the +// `data__value` prefix for these methods. +console.log(`[generate-provider] rewriting application/octet-stream request bodies...`); +const octet = spawnSync(pythonBin, ['-m', 'stackql_cloudflare_provider.octet_stream_requests'], { + cwd: BASE_DIR, + stdio: 'inherit', +}); +if (octet.status !== 0) { + console.error(`[generate-provider] octet_stream_requests failed with exit ${octet.status}`); + process.exit(octet.status ?? 1); +} + +// Post-process: collapse the ~93 per-model Workers AI run resources into +// ~9 task-family SELECT resources (cloudflare.ai.text_generation, etc.) +// riding the generic /ai/run/{model_name} operation with model_name as +// the discriminator. Config: provider-dev/config/ai_task_families.yaml. +console.log(`[generate-provider] collapsing Workers AI models into task-family resources...`); +const aiFam = spawnSync(pythonBin, ['-m', 'stackql_cloudflare_provider.ai_task_families'], { + cwd: BASE_DIR, + stdio: 'inherit', +}); +if (aiFam.status !== 0) { + console.error(`[generate-provider] ai_task_families failed with exit ${aiFam.status}`); + process.exit(aiFam.status ?? 1); +} + +// Post-process: fix response shapes for resources whose SELECT would +// yield no columns (untyped result items, scalar arrays, raw text +// bodies, dynamic objects). Config: provider-dev/config/ +// select_response_fixes.yaml. +console.log(`[generate-provider] fixing empty-column select response shapes...`); +const selFix = spawnSync(pythonBin, ['-m', 'stackql_cloudflare_provider.select_response_fixes'], { + cwd: BASE_DIR, + stdio: 'inherit', +}); +if (selFix.status !== 0) { + console.error(`[generate-provider] select_response_fixes failed with exit ${selFix.status}`); + process.exit(selFix.status ?? 1); +} + // Post-process: shim hand-authored Cloudflare GraphQL operations into // the matching service yamls. Source manifest + per-op specs live under // provider-dev/source-graphql/. The merge script is idempotent and only diff --git a/stackql_cloudflare/bin/smoke-test-kv.cjs b/stackql_cloudflare/bin/smoke-test-kv.cjs new file mode 100644 index 00000000000..66072b0d888 --- /dev/null +++ b/stackql_cloudflare/bin/smoke-test-kv.cjs @@ -0,0 +1,231 @@ +#!/usr/bin/env node +// Full-cycle KV smoke test against a running local stackql server. +// +// Exercises the complete Workers KV lifecycle through stackql, including +// the application/octet-stream request-body handling for kv.values +// (see stackql_cloudflare_provider/octet_stream_requests.py - the value +// PUT sends the raw body, addressed as the required `data__value` column): +// +// 1. INSERT cloudflare.kv.namespaces (create a scratch namespace) +// 2. REPLACE cloudflare.kv.values (write a value - octet-stream body) +// 3. SELECT cloudflare.kv.values (read it back, assert round-trip) +// 4. SELECT cloudflare.kv.keys (assert the key is listed) +// 5. DELETE cloudflare.kv.values (delete the key) +// 6. SELECT cloudflare.kv.values (assert it is gone) +// 7. DELETE cloudflare.kv.namespaces (delete the scratch namespace) +// +// Prerequisites: +// - local server running (npm run start-server) with CLOUDFLARE_API_TOKEN +// set to a token carrying "Workers KV Storage: Edit" on the account +// - CLOUDFLARE_ACCOUNT_ID set in the environment (or pass --account) +// +// Usage: +// node bin/smoke-test-kv.cjs [--port 5444] [--account ] [--verbose] [--keep] + +const { runQuery } = require('@stackql/pgwire-lite'); + +const args = process.argv.slice(2); +let port = 5444; +let verbose = false; +let keep = false; +let accountId = process.env.CLOUDFLARE_ACCOUNT_ID || ''; + +for (let i = 0; i < args.length; i++) { + switch (args[i]) { + case '--port': + port = parseInt(args[++i], 10); + break; + case '--account': + accountId = args[++i]; + break; + case '--verbose': + verbose = true; + break; + case '--keep': + keep = true; + break; + case '--help': + console.log('Usage: smoke-test-kv.cjs [--port PORT] [--account ACCOUNT_ID] [--verbose] [--keep]'); + process.exit(0); + break; + default: + console.error(`Error: Unknown option "${args[i]}"`); + process.exit(1); + } +} + +if (!accountId) { + console.error('Error: account id required - set CLOUDFLARE_ACCOUNT_ID or pass --account'); + process.exit(1); +} + +const connectionOptions = { + user: 'stackql', + database: 'stackql', + host: 'localhost', + port, + debug: false, +}; + +const runId = Date.now().toString(36); +const nsTitle = `stackql-smoke-${runId}`; +const keyName = 'stackql_smoke_key'; +const keyValue = `stackql-smoke-value-${runId}`; + +// Mutations (REPLACE / DELETE without RETURNING) legitimately produce no +// result set - pgwire-lite surfaces that as an error we treat as success. +const NO_RESULT = "didn't produce a result"; + +async function query(sql, description, { allowNoResult = false, allowError = null } = {}) { + if (verbose) { + console.log(`\n-- ${description}\n${sql}`); + } else { + process.stdout.write(`${description}... `); + } + try { + const result = await runQuery(connectionOptions, sql); + const rows = result.data || []; + if (!verbose) console.log(`ok (${rows.length} rows)`); + else console.log(rows); + return rows; + } catch (error) { + const msg = error.message || ''; + if (allowNoResult && msg.includes(NO_RESULT)) { + if (!verbose) console.log('ok'); + return []; + } + if (allowError && allowError.test(msg)) { + if (!verbose) console.log(`ok (expected error: ${msg.trim()})`); + return null; + } + if (!verbose) console.log('FAILED'); + throw new Error(`${description} failed: ${msg}`); + } +} + +function fail(message) { + console.error(`\nSMOKE TEST FAILED: ${message}`); + process.exitCode = 1; +} + +async function findNamespaceIdByTitle(title) { + // Pagination is disabled provider-wide (first page only), so a busy + // account may not list the scratch namespace - RETURNING is the + // primary id source, this is the fallback. + const rows = await query( + `SELECT id, title FROM cloudflare.kv.namespaces WHERE account_id = '${accountId}'`, + 'Listing namespaces (fallback id lookup)' + ); + const match = (rows || []).find(r => r.title === title); + return match ? match.id : null; +} + +async function main() { + console.log(`\nKV full-cycle smoke test (account ${accountId}, namespace title ${nsTitle})\n`); + let namespaceId = null; + + try { + // 1. create scratch namespace + let rows; + try { + rows = await query( + `INSERT INTO cloudflare.kv.namespaces (title, account_id) SELECT '${nsTitle}', '${accountId}' RETURNING result`, + 'Creating scratch namespace' + ); + } catch (e) { + if ((e.message || '').includes(NO_RESULT)) { + rows = []; + } else { + throw e; + } + } + if (rows.length) { + const raw = rows[0].result; + try { + const parsed = typeof raw === 'string' ? JSON.parse(raw) : raw; + namespaceId = parsed && parsed.id; + } catch { + namespaceId = null; + } + } + if (!namespaceId) { + namespaceId = await findNamespaceIdByTitle(nsTitle); + } + if (!namespaceId) { + throw new Error('could not determine created namespace id'); + } + console.log(` namespace id: ${namespaceId}`); + + // 2. write a value - the octet-stream request body path. data__value + // is mandatory here: naive requestBodyTranslate is disabled for this + // method and the transform splats data__value verbatim as the raw body. + await query( + `REPLACE cloudflare.kv.values SET data__value = '${keyValue}' ` + + `WHERE account_id = '${accountId}' AND namespace_id = '${namespaceId}' AND key_name = '${keyName}'`, + 'Writing value (REPLACE with data__value)', + { allowNoResult: true } + ); + + // 3. read it back + const got = await query( + `SELECT contents FROM cloudflare.kv.values ` + + `WHERE account_id = '${accountId}' AND namespace_id = '${namespaceId}' AND key_name = '${keyName}'`, + 'Reading value back' + ); + if (!got.length || got[0].contents !== keyValue) { + throw new Error(`round-trip mismatch: expected '${keyValue}', got '${got.length ? got[0].contents : ''}'`); + } + console.log(' round-trip value matches'); + + // 4. key shows up in the key listing + const keys = await query( + `SELECT name FROM cloudflare.kv.keys WHERE account_id = '${accountId}' AND namespace_id = '${namespaceId}'`, + 'Listing keys' + ); + if (!(keys || []).some(k => k.name === keyName)) { + throw new Error(`key '${keyName}' not present in key listing`); + } + + // 5. delete the key + await query( + `DELETE FROM cloudflare.kv.values ` + + `WHERE account_id = '${accountId}' AND namespace_id = '${namespaceId}' AND key_name = '${keyName}'`, + 'Deleting value', + { allowNoResult: true } + ); + + // 6. confirm it is gone (Cloudflare 404s - stackql surfaces an error + // or an empty result depending on version; both count as deleted) + const after = await query( + `SELECT contents FROM cloudflare.kv.values ` + + `WHERE account_id = '${accountId}' AND namespace_id = '${namespaceId}' AND key_name = '${keyName}'`, + 'Confirming value deleted', + { allowError: /404|not found|key not found/i } + ); + if (after && after.length && after[0].contents === keyValue) { + throw new Error('value still readable after DELETE'); + } + + console.log('\nKV full cycle PASSED'); + } catch (error) { + fail(error.message); + } finally { + // 7. always try to remove the scratch namespace + if (namespaceId && !keep) { + try { + await query( + `DELETE FROM cloudflare.kv.namespaces ` + + `WHERE namespace_id = '${namespaceId}' AND account_id = '${accountId}'`, + 'Deleting scratch namespace', + { allowNoResult: true } + ); + } catch (error) { + fail(`cleanup failed - namespace '${nsTitle}' (${namespaceId}) may need manual deletion: ${error.message}`); + } + } else if (namespaceId && keep) { + console.log(`--keep set: leaving namespace '${nsTitle}' (${namespaceId}) in place`); + } + } +} + +main(); diff --git a/stackql_cloudflare/examples/analytics/dns_analytics.iql b/stackql_cloudflare/examples/analytics/dns_analytics.iql index a8a9ed10fc3..6df73b4202a 100644 --- a/stackql_cloudflare/examples/analytics/dns_analytics.iql +++ b/stackql_cloudflare/examples/analytics/dns_analytics.iql @@ -1,16 +1,16 @@ --- Replacement for the deprecated REST endpoints /zones/{zone_id}/dns_analytics/* --- (hard EOL 2026-12-01). Returns DNS query analytics grouped by --- query name + query type + response code over the requested window. - -SELECT - query_name, - query_type, - response_code, - sum(queries) AS total_queries -FROM cloudflare.dns.dns_analytics_adaptive_groups -WHERE zone_tag = '' - AND since = '' - AND until = '' -GROUP BY query_name, query_type, response_code -ORDER BY total_queries DESC -LIMIT 25; +-- Replacement for the deprecated REST endpoints /zones/{zone_id}/dns_analytics/* +-- (hard EOL 2026-12-01). Returns DNS query analytics grouped by +-- query name + query type + response code over the requested window. + +SELECT + query_name, + query_type, + response_code, + sum(queries) AS total_queries +FROM cloudflare.dns.analytics_adaptive_groups +WHERE zone_tag = '' + AND since = '' + AND until = '' +GROUP BY query_name, query_type, response_code +ORDER BY total_queries DESC +LIMIT 25; diff --git a/stackql_cloudflare/examples/analytics/workers_invocations.iql b/stackql_cloudflare/examples/analytics/workers_invocations.iql index 7d862104d44..c292f6df21d 100644 --- a/stackql_cloudflare/examples/analytics/workers_invocations.iql +++ b/stackql_cloudflare/examples/analytics/workers_invocations.iql @@ -1,17 +1,17 @@ --- Top Workers scripts by invocation count + error rate for the --- requested window. - -SELECT - script_name, - status, - sum(requests) AS invocations, - sum(errors) AS errors, - sum(cpu_time_us) AS cpu_time_us, - sum(subrequests) AS subrequests -FROM cloudflare.workers.workers_invocations -WHERE account_tag = '' - AND since = '' - AND until = '' -GROUP BY script_name, status -ORDER BY invocations DESC -LIMIT 25; +-- Top Workers scripts by invocation count + error rate for the +-- requested window. + +SELECT + script_name, + status, + sum(requests) AS invocations, + sum(errors) AS errors, + sum(cpu_time_us) AS cpu_time_us, + sum(subrequests) AS subrequests +FROM cloudflare.workers.invocations +WHERE account_tag = '' + AND since = '' + AND until = '' +GROUP BY script_name, status +ORDER BY invocations DESC +LIMIT 25; diff --git a/stackql_cloudflare/package.json b/stackql_cloudflare/package.json index 7fa2d863a56..dddc1f7106c 100644 --- a/stackql_cloudflare/package.json +++ b/stackql_cloudflare/package.json @@ -11,7 +11,8 @@ "start-server": "bash ./bin/start-server.sh", "stop-server": "bash ./bin/stop-server.sh", "server-status": "bash ./bin/server-status.sh", - "test-meta-routes": "node ./bin/test-meta-routes.cjs cloudflare" + "test-meta-routes": "node ./bin/test-meta-routes.cjs cloudflare", + "smoke-test-kv": "node ./bin/smoke-test-kv.cjs" }, "dependencies": { "@stackql/pgwire-lite": "^1.0.1", diff --git a/stackql_cloudflare/provider-dev/config/ai_task_families.yaml b/stackql_cloudflare/provider-dev/config/ai_task_families.yaml new file mode 100644 index 00000000000..17aa2f1505d --- /dev/null +++ b/stackql_cloudflare/provider-dev/config/ai_task_families.yaml @@ -0,0 +1,229 @@ +# Workers AI task-family collapse configuration. +# +# Consumed by stackql_cloudflare_provider/ai_task_families.py (a +# generate-provider post-pass). Each family becomes a single StackQL +# resource (cloudflare.ai.) with a `run` select method riding the +# generic POST /accounts/{account_id}/ai/run/{model_name} operation; +# `model_name` is the discriminator (WHERE model_name = '@cf/...'). +# The listed member models' per-model paths and resources are REMOVED +# from the generated provider. +# +# mode: object -> response objectKey $.result with the typed result_fields +# mode: contents -> response wrapped as a single `contents` column (binary +# or non-object results) +# +# excluded_octet_input_models cannot be SELECT methods: their input is a +# raw octet-stream body (handled by octet_stream_requests.py via +# data__value) which cannot be expressed as WHERE params. They are folded +# into the generic `run` resource as exec methods via all_services.csv +# (resource=run, verb=exec, method=). +# +# New models added upstream land as new per-model resources until added +# to a members list here. The generic cloudflare.ai.run resource remains +# as the escape hatch for any model not yet listed. +families: + text_generation: + title: Text Generation + description: LLM chat and completion models (llama, qwen, gemma, mistral, gpt-oss, phi, deepseek, and more). + Provide prompt or messages. + mode: object + result_fields: + response: + type: string + description: The generated text response from the model. + usage: + type: object + description: Token usage counts (prompt_tokens, completion_tokens, total_tokens). + tool_calls: + type: array + items: + type: object + description: Tool call requests emitted by the model, if tools were provided. + members: + - '@cf/aisingapore/gemma-sea-lion-v4-27b-it' + - '@cf/deepseek-ai/deepseek-math-7b-instruct' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/defog/sqlcoder-7b-2' + - '@cf/fblgit/una-cybertron-7b-v2-bf16' + - '@cf/google/gemma-2b-it-lora' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-7b-it-lora' + - '@cf/ibm-granite/granite-4.0-h-micro' + - '@cf/meta-llama/llama-2-7b-chat-hf-lora' + - '@cf/meta/llama-2-7b-chat-fp16' + - '@cf/meta/llama-2-7b-chat-int8' + - '@cf/meta/llama-3-8b-instruct' + - '@cf/meta/llama-3-8b-instruct-awq' + - '@cf/meta/llama-3.1-70b-instruct-fp8-fast' + - '@cf/meta/llama-3.1-8b-instruct-awq' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-3.1-8b-instruct-fp8-fast' + - '@cf/meta/llama-3.2-11b-vision-instruct' + - '@cf/meta/llama-3.2-1b-instruct' + - '@cf/meta/llama-3.2-3b-instruct' + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/meta/llama-guard-3-8b' + - '@cf/microsoft/phi-2' + - '@cf/mistral/mistral-7b-instruct-v0.1' + - '@cf/mistral/mistral-7b-instruct-v0.2-lora' + - '@cf/mistralai/mistral-small-3.1-24b-instruct' + - '@cf/moonshotai/kimi-k2.5' + - '@cf/nvidia/nemotron-3-120b-a12b' + - '@cf/openai/gpt-oss-120b' + - '@cf/openai/gpt-oss-20b' + - '@cf/openchat/openchat-3.5-0106' + - '@cf/qwen/qwen1.5-0.5b-chat' + - '@cf/qwen/qwen1.5-1.8b-chat' + - '@cf/qwen/qwen1.5-14b-chat-awq' + - '@cf/qwen/qwen1.5-7b-chat-awq' + - '@cf/qwen/qwen2.5-coder-32b-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/qwen/qwq-32b' + - '@cf/thebloke/discolm-german-7b-v1-awq' + - '@cf/tiiuae/falcon-7b-instruct' + - '@cf/tinyllama/tinyllama-1.1b-chat-v1.0' + - '@cf/zai-org/glm-4.7-flash' + - '@hf/google/gemma-7b-it' + - '@hf/mistral/mistral-7b-instruct-v0.2' + - '@hf/nexusflow/starling-lm-7b-beta' + - '@hf/nousresearch/hermes-2-pro-mistral-7b' + - '@hf/thebloke/deepseek-coder-6.7b-base-awq' + - '@hf/thebloke/deepseek-coder-6.7b-instruct-awq' + - '@hf/thebloke/llama-2-13b-chat-awq' + - '@hf/thebloke/mistral-7b-instruct-v0.1-awq' + - '@hf/thebloke/neural-chat-7b-v3-1-awq' + - '@hf/thebloke/openhermes-2.5-mistral-7b-awq' + - '@hf/thebloke/zephyr-7b-beta-awq' + text_embeddings: + title: Text Embeddings + description: Embedding models (bge, embeddinggemma, plamo, qwen3-embedding). Provide text (string or array of + strings). + mode: object + result_fields: + shape: + type: array + items: + type: integer + description: Dimensions of the returned embedding matrix. + data: + type: array + items: + type: array + items: + type: number + description: Embedding vectors, one per input text. + pooling: + type: string + description: Pooling method used (cls or mean), where applicable. + members: + - '@cf/baai/bge-base-en-v1.5' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-small-en-v1.5' + - '@cf/baai/nonomni-bge-base-en-v1.5' + - '@cf/baai/nonomni-bge-large-en-v1.5' + - '@cf/baai/nonomni-bge-m3' + - '@cf/baai/nonomni-bge-small-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - '@cf/google/nonomni-embeddinggemma-300m' + - '@cf/pfnet/plamo-embedding-1b' + - '@cf/qwen/qwen3-embedding-0.6b' + speech_to_text: + title: Speech to Text + description: Speech recognition models with JSON input (nova-3, whisper-large-v3-turbo, deepgram flux). Provide + audio as base64 in the audio property. + mode: object + result_fields: + text: + type: string + description: The transcribed text. + word_count: + type: number + description: Number of words in the transcription, where reported. + words: + type: array + items: + type: object + description: Per-word timing detail, where reported. + vtt: + type: string + description: WebVTT formatted transcription, where reported. + transcription_info: + type: object + description: Model/language detail, where reported. + members: + - '@cf/deepgram/flux' + - '@cf/deepgram/nova-3' + - '@cf/openai/whisper-large-v3-turbo' + translation: + title: Translation + description: Translation models (m2m100, indictrans2). Provide text and target_lang / target_language. + mode: object + result_fields: + translated_text: + type: string + description: The translated text. + members: + - '@cf/ai4bharat/indictrans2-en-indic-1B' + - '@cf/ai4bharat/nonomni-indictrans2-en-indic-1b' + - '@cf/meta/m2m100-1.2b' + summarization: + title: Summarization + description: Summarization models (bart-large-cnn). Provide input_text. + mode: object + result_fields: + summary: + type: string + description: The summarized text. + members: + - '@cf/facebook/bart-large-cnn' + - '@cf/facebook/nonomni-bart-large-cnn' + text_to_image: + title: Text to Image + description: Image generation models (stable-diffusion, flux, dreamshaper, leonardo). Returns raw image bytes + or JSON with base64 image depending on the model - projected as a contents column. + mode: contents + members: + - '@cf/black-forest-labs/flux-1-schnell' + - '@cf/black-forest-labs/flux-2-dev' + - '@cf/black-forest-labs/flux-2-klein-4b' + - '@cf/black-forest-labs/flux-2-klein-9b' + - '@cf/bytedance/stable-diffusion-xl-lightning' + - '@cf/leonardo/lucid-origin' + - '@cf/leonardo/phoenix-1.0' + - '@cf/lykon/dreamshaper-8-lcm' + - '@cf/runwayml/stable-diffusion-v1-5-img2img' + - '@cf/runwayml/stable-diffusion-v1-5-inpainting' + - '@cf/stabilityai/stable-diffusion-xl-base-1.0' + text_to_speech: + title: Text to Speech + description: Speech synthesis models (aura, melotts). Returns audio bytes or JSON with base64 audio depending + on the model - projected as a contents column. + mode: contents + members: + - '@cf/deepgram/aura-1' + - '@cf/deepgram/aura-2-en' + - '@cf/deepgram/aura-2-es' + - '@cf/myshell-ai/melotts' + text_classification: + title: Text Classification + description: Sentiment / text classification models (distilbert-sst-2). Result is an array of label/score pairs + - projected as a contents column. + mode: contents + members: + - '@cf/huggingface/distilbert-sst-2-int8' + - '@cf/huggingface/nonomni-distilbert-sst-2-int8' + reranking: + title: Reranking + description: Reranker models (bge-reranker-base). Provide query and contexts. Result is an array of id/score + pairs - projected as a contents column. + mode: contents + members: + - '@cf/baai/bge-reranker-base' +excluded_octet_input_models: +- '@cf/facebook/nonomni-detr-resnet-50' +- '@cf/microsoft/nonomni-resnet-50' +- '@cf/microsoft/resnet-50' +- '@cf/openai/whisper' +- '@cf/openai/whisper-tiny-en' diff --git a/stackql_cloudflare/provider-dev/config/all_services.csv b/stackql_cloudflare/provider-dev/config/all_services.csv index 724d92d97d2..6a0d598697a 100644 --- a/stackql_cloudflare/provider-dev/config/all_services.csv +++ b/stackql_cloudflare/provider-dev/config/all_services.csv @@ -53,12 +53,12 @@ addressing.yaml,/accounts/{account_id}/addressing/address_maps,ip-address-manage addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id},ip-address-management-address-maps-delete-address-map,ip_address_management_address_maps_delete_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,delete,delete,,Delete Address Map addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id},ip-address-management-address-maps-address-map-details,ip_address_management_address_maps_address_map_details,get,addressingFullResponse,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,get,select,$.result,Address Map Details addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id},ip-address-management-address-maps-update-address-map,ip_address_management_address_maps_update_address_map,patch,addressingComponentsSchemasSingleResponse,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,edit,update,,Update Address Map -addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id},ip-address-management-address-maps-remove-an-account-membership-from-an-address-map,ip_address_management_address_maps_remove_an_account_membership_from_an_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,accounts,delete,delete,,Remove an account membership from an Address Map -addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id},ip-address-management-address-maps-add-an-account-membership-to-an-address-map,ip_address_management_address_maps_add_an_account_membership_to_an_address_map,put,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,accounts,update,replace,,Add an account membership to an Address Map -addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address},ip-address-management-address-maps-remove-an-ip-from-an-address-map,ip_address_management_address_maps_remove_an_ip_from_an_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,ips,delete,delete,,Remove an IP from an Address Map -addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address},ip-address-management-address-maps-add-an-ip-to-an-address-map,ip_address_management_address_maps_add_an_ip_to_an_address_map,put,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,ips,update,replace,,Add an IP to an Address Map -addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id},ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map,ip_address_management_address_maps_remove_a_zone_membership_from_an_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,zones,delete,delete,,Remove a zone membership from an Address Map -addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id},ip-address-management-address-maps-add-a-zone-membership-to-an-address-map,ip_address_management_address_maps_add_a_zone_membership_to_an_address_map,put,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,zones,update,replace,,Add a zone membership to an Address Map +addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id},ip-address-management-address-maps-remove-an-account-membership-from-an-address-map,ip_address_management_address_maps_remove_an_account_membership_from_an_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,remove_account,exec,,Remove an account membership from an Address Map +addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id},ip-address-management-address-maps-add-an-account-membership-to-an-address-map,ip_address_management_address_maps_add_an_account_membership_to_an_address_map,put,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,add_account,exec,,Add an account membership to an Address Map +addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address},ip-address-management-address-maps-remove-an-ip-from-an-address-map,ip_address_management_address_maps_remove_an_ip_from_an_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,remove_ip,exec,,Remove an IP from an Address Map +addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address},ip-address-management-address-maps-add-an-ip-to-an-address-map,ip_address_management_address_maps_add_an_ip_to_an_address_map,put,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,add_ip,exec,,Add an IP to an Address Map +addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id},ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map,ip_address_management_address_maps_remove_a_zone_membership_from_an_address_map,delete,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,remove_zone,exec,,Remove a zone membership from an Address Map +addressing.yaml,/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id},ip-address-management-address-maps-add-a-zone-membership-to-an-address-map,ip_address_management_address_maps_add_a_zone_membership_to_an_address_map,put,addressingApiResponseCollection,IP Address Management Address Maps,ip_address_management_address_maps,address_maps,add_zone,exec,,Add a zone membership to an Address Map addressing.yaml,/accounts/{account_id}/addressing/leases,ip-address-management-list-leases,ip_address_management_list_leases,get,addressingLeasesComponentsSchemasResponseCollection,IP Address Management Leases,ip_address_management_leases,leases,list,select,$.result,List Leases addressing.yaml,/accounts/{account_id}/addressing/loa_documents,ip-address-management-prefixes-upload-loa-document,ip_address_management_prefixes_upload_loa_document,post,addressingLoaUploadResponse,IP Address Management Prefixes,ip_address_management_prefixes,loa_documents,create,insert,,Upload LOA Document addressing.yaml,/accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download,ip-address-management-prefixes-download-loa-document,ip_address_management_prefixes_download_loa_document,get,,IP Address Management Prefixes,ip_address_management_prefixes,loa_documents,list,select,,Download LOA Document @@ -81,7 +81,7 @@ addressing.yaml,/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/ addressing.yaml,/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations,ip-address-management-prefix-delegation-list-prefix-delegations,ip_address_management_prefix_delegation_list_prefix_delegations,get,addressingSchemasResponseCollection,IP Address Management Prefix Delegation,ip_address_management_prefix_delegation,delegations,list,select,$.result,List Prefix Delegations addressing.yaml,/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations,ip-address-management-prefix-delegation-create-prefix-delegation,ip_address_management_prefix_delegation_create_prefix_delegation,post,addressingSchemasSingleResponse,IP Address Management Prefix Delegation,ip_address_management_prefix_delegation,delegations,create,insert,,Create Prefix Delegation addressing.yaml,/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id},ip-address-management-prefix-delegation-delete-prefix-delegation,ip_address_management_prefix_delegation_delete_prefix_delegation,delete,addressingIdResponse,IP Address Management Prefix Delegation,ip_address_management_prefix_delegation,delegations,delete,delete,,Delete Prefix Delegation -addressing.yaml,/accounts/{account_id}/addressing/prefixes/{prefix_id}/validate,ip-address-management-prefixes-validate-prefix,ip_address_management_prefixes_validate_prefix,post,addressingSingleResponse,IP Address Management Prefixes,ip_address_management_prefixes,validate,ip_address_management_prefixes_validate_prefix,insert,,Validate Prefix +addressing.yaml,/accounts/{account_id}/addressing/prefixes/{prefix_id}/validate,ip-address-management-prefixes-validate-prefix,ip_address_management_prefixes_validate_prefix,post,addressingSingleResponse,IP Address Management Prefixes,ip_address_management_prefixes,prefixes,validate_prefix,exec,,Validate Prefix addressing.yaml,/accounts/{account_id}/addressing/regional_hostnames/regions,dls-account-regional-hostnames-account-list-regions,dls_account_regional_hostnames_account_list_regions,get,,DLS Regional Services,dls_regional_services,regions,list,select,$.result,List Regions addressing.yaml,/accounts/{account_id}/addressing/services,ip-address-management-service-bindings-list-services,ip_address_management_service_bindings_list_services,get,,IP Address Management Service Bindings,ip_address_management_service_bindings,services,list,select,$.result,List Services addressing.yaml,/zones/{zone_id}/addressing/regional_hostnames,dls-account-regional-hostnames-account-list-hostnames,dls_account_regional_hostnames_account_list_hostnames,get,,DLS Regional Services,dls_regional_services,regional_hostnames,list,select,$.result,List Regional Hostnames @@ -93,7 +93,7 @@ ai.yaml,/accounts/{account_id}/ai/authors/search,workers-ai-search-author,worker ai.yaml,/accounts/{account_id}/ai/finetunes,workers-ai-list-finetunes,workers_ai_list_finetunes,get,,Workers AI Finetune,workers_ai_finetune,finetunes,list,select,$.result,List Finetunes ai.yaml,/accounts/{account_id}/ai/finetunes,workers-ai-create-finetune,workers_ai_create_finetune,post,,Workers AI Finetune,workers_ai_finetune,finetunes,create,insert,,Create a new Finetune ai.yaml,/accounts/{account_id}/ai/finetunes/public,workers-ai-list-public-finetunes,workers_ai_list_public_finetunes,get,,Workers AI Finetune,workers_ai_finetune,public,list,select,$.result,List Public Finetunes -ai.yaml,/accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets,workers-ai-upload-finetune-asset,workers_ai_upload_finetune_asset,post,,Workers AI Finetune,workers_ai_finetune,assets,create,insert,,Upload a Finetune Asset +ai.yaml,/accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets,workers-ai-upload-finetune-asset,workers_ai_upload_finetune_asset,post,,Workers AI Finetune,workers_ai_finetune,finetunes,upload_asset,exec,,Upload a Finetune Asset ai.yaml,/accounts/{account_id}/ai/models/schema,workers-ai-get-model-schema,workers_ai_get_model_schema,get,,Workers AI,workers_ai,schema,list,select,$.result,Get Model Schema ai.yaml,/accounts/{account_id}/ai/models/search,workers-ai-search-model,workers_ai_search_model,get,,Workers AI,workers_ai,models,list,select,$.result,Model Search ai.yaml,/accounts/{account_id}/ai/run/@cf/ai4bharat/indictrans2-en-indic-1B,workers-ai-post-run-cf-ai4bharat-indictrans2-en-indic-1B,workers_ai_post_run_cf_ai4bharat_indictrans2_en_indic_1B,post,,Workers AI Translation,workers_ai_translation,indictrans2_en_indic_1_b,workers_ai_post_run_cf_ai4bharat_indictrans2_en_indic_1_b,insert,,Execute @cf/ai4bharat/indictrans2-en-indic-1B model. @@ -123,7 +123,7 @@ ai.yaml,/accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-r1-distill-qwen-3 ai.yaml,/accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2,workers-ai-post-run-cf-defog-sqlcoder-7b-2,workers_ai_post_run_cf_defog_sqlcoder_7b_2,post,,Workers AI Text Generation,workers_ai_text_generation,sqlcoder_7b_2,workers_ai_post_run_cf_defog_sqlcoder_7b_2,insert,,Execute @cf/defog/sqlcoder-7b-2 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn,workers-ai-post-run-cf-facebook-bart-large-cnn,workers_ai_post_run_cf_facebook_bart_large_cnn,post,,Workers AI Summarization,workers_ai_summarization,bart_large_cnn,workers_ai_post_run_cf_facebook_bart_large_cnn,insert,,Execute @cf/facebook/bart-large-cnn model. ai.yaml,/accounts/{account_id}/ai/run/@cf/facebook/nonomni-bart-large-cnn,workers-ai-post-run-cf-facebook-nonomni-bart-large-cnn,workers_ai_post_run_cf_facebook_nonomni_bart_large_cnn,post,,Workers AI Summarization,workers_ai_summarization,nonomni_bart_large_cnn,workers_ai_post_run_cf_facebook_nonomni_bart_large_cnn,insert,,Execute @cf/facebook/nonomni-bart-large-cnn model. -ai.yaml,/accounts/{account_id}/ai/run/@cf/facebook/nonomni-detr-resnet-50,workers-ai-post-run-cf-facebook-nonomni-detr-resnet-50,workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50,post,,Workers AI Object Detection,workers_ai_object_detection,nonomni_detr_resnet_50,workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50,insert,,Execute @cf/facebook/nonomni-detr-resnet-50 model. +ai.yaml,/accounts/{account_id}/ai/run/@cf/facebook/nonomni-detr-resnet-50,workers-ai-post-run-cf-facebook-nonomni-detr-resnet-50,workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50,post,,Workers AI Object Detection,workers_ai_object_detection,run,nonomni_detr_resnet_50,exec,,Execute @cf/facebook/nonomni-detr-resnet-50 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/fblgit/una-cybertron-7b-v2-bf16,workers-ai-post-run-cf-fblgit-una-cybertron-7b-v2-bf16,workers_ai_post_run_cf_fblgit_una_cybertron_7b_v2_bf16,post,,Workers AI Text Generation,workers_ai_text_generation,una_cybertron_7b_v2_bf16,workers_ai_post_run_cf_fblgit_una_cybertron_7b_v2_bf16,insert,,Execute @cf/fblgit/una-cybertron-7b-v2-bf16 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/google/embeddinggemma-300m,workers-ai-post-run-cf-google-embeddinggemma-300m,workers_ai_post_run_cf_google_embeddinggemma_300m,post,,Workers AI Text Embeddings,workers_ai_text_embeddings,embeddinggemma_300m,workers_ai_post_run_cf_google_embeddinggemma_300m,insert,,Execute @cf/google/embeddinggemma-300m model. ai.yaml,/accounts/{account_id}/ai/run/@cf/google/gemma-2b-it-lora,workers-ai-post-run-cf-google-gemma-2b-it-lora,workers_ai_post_run_cf_google_gemma_2b_it_lora,post,,Workers AI Text Generation,workers_ai_text_generation,gemma_2b_it_lora,workers_ai_post_run_cf_google_gemma_2b_it_lora,insert,,Execute @cf/google/gemma-2b-it-lora model. @@ -152,9 +152,9 @@ ai.yaml,/accounts/{account_id}/ai/run/@cf/meta/llama-3.3-70b-instruct-fp8-fast,w ai.yaml,/accounts/{account_id}/ai/run/@cf/meta/llama-4-scout-17b-16e-instruct,workers-ai-post-run-cf-meta-llama-4-scout-17b-16e-instruct,workers_ai_post_run_cf_meta_llama_4_scout_17b_16e_instruct,post,,Workers AI Text Generation,workers_ai_text_generation,llama_4_scout_17b_16e_instruct,workers_ai_post_run_cf_meta_llama_4_scout_17b_16e_instruct,insert,,Execute @cf/meta/llama-4-scout-17b-16e-instruct model. ai.yaml,/accounts/{account_id}/ai/run/@cf/meta/llama-guard-3-8b,workers-ai-post-run-cf-meta-llama-guard-3-8b,workers_ai_post_run_cf_meta_llama_guard_3_8b,post,,Workers AI Text Generation,workers_ai_text_generation,llama_guard_3_8b,workers_ai_post_run_cf_meta_llama_guard_3_8b,insert,,Execute @cf/meta/llama-guard-3-8b model. ai.yaml,/accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b,workers-ai-post-run-cf-meta-m2m100-1-2b,workers_ai_post_run_cf_meta_m2m100_1_2b,post,,Workers AI Translation,workers_ai_translation,m2m100_1_2b,workers_ai_post_run_cf_meta_m2m100_1_2b,insert,,Execute @cf/meta/m2m100-1.2b model. -ai.yaml,/accounts/{account_id}/ai/run/@cf/microsoft/nonomni-resnet-50,workers-ai-post-run-cf-microsoft-nonomni-resnet-50,workers_ai_post_run_cf_microsoft_nonomni_resnet_50,post,,Workers AI Image Classification,workers_ai_image_classification,nonomni_resnet_50,workers_ai_post_run_cf_microsoft_nonomni_resnet_50,insert,,Execute @cf/microsoft/nonomni-resnet-50 model. +ai.yaml,/accounts/{account_id}/ai/run/@cf/microsoft/nonomni-resnet-50,workers-ai-post-run-cf-microsoft-nonomni-resnet-50,workers_ai_post_run_cf_microsoft_nonomni_resnet_50,post,,Workers AI Image Classification,workers_ai_image_classification,run,nonomni_resnet_50,exec,,Execute @cf/microsoft/nonomni-resnet-50 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/microsoft/phi-2,workers-ai-post-run-cf-microsoft-phi-2,workers_ai_post_run_cf_microsoft_phi_2,post,,Workers AI Text Generation,workers_ai_text_generation,phi_2,workers_ai_post_run_cf_microsoft_phi_2,insert,,Execute @cf/microsoft/phi-2 model. -ai.yaml,/accounts/{account_id}/ai/run/@cf/microsoft/resnet-50,workers-ai-post-run-cf-microsoft-resnet-50,workers_ai_post_run_cf_microsoft_resnet_50,post,,Workers AI Image Classification,workers_ai_image_classification,resnet_50,workers_ai_post_run_cf_microsoft_resnet_50,insert,,Execute @cf/microsoft/resnet-50 model. +ai.yaml,/accounts/{account_id}/ai/run/@cf/microsoft/resnet-50,workers-ai-post-run-cf-microsoft-resnet-50,workers_ai_post_run_cf_microsoft_resnet_50,post,,Workers AI Image Classification,workers_ai_image_classification,run,resnet_50,exec,,Execute @cf/microsoft/resnet-50 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1,workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1,workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_1,post,,Workers AI Text Generation,workers_ai_text_generation,mistral_7b_instruct_v0_1,workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_1,insert,,Execute @cf/mistral/mistral-7b-instruct-v0.1 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.2-lora,workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-2-lora,workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_2_lora,post,,Workers AI Text Generation,workers_ai_text_generation,mistral_7b_instruct_v0_2_lora,workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_2_lora,insert,,Execute @cf/mistral/mistral-7b-instruct-v0.2-lora model. ai.yaml,/accounts/{account_id}/ai/run/@cf/mistralai/mistral-small-3.1-24b-instruct,workers-ai-post-run-cf-mistralai-mistral-small-3-1-24b-instruct,workers_ai_post_run_cf_mistralai_mistral_small_3_1_24b_instruct,post,,Workers AI Text Generation,workers_ai_text_generation,mistral_small_3_1_24b_instruct,workers_ai_post_run_cf_mistralai_mistral_small_3_1_24b_instruct,insert,,Execute @cf/mistralai/mistral-small-3.1-24b-instruct model. @@ -163,9 +163,9 @@ ai.yaml,/accounts/{account_id}/ai/run/@cf/myshell-ai/melotts,workers-ai-post-run ai.yaml,/accounts/{account_id}/ai/run/@cf/nvidia/nemotron-3-120b-a12b,workers-ai-post-run-cf-nvidia-nemotron-3-120b-a12b,workers_ai_post_run_cf_nvidia_nemotron_3_120b_a12b,post,,Workers AI Text Generation,workers_ai_text_generation,nemotron_3_120b_a12b,workers_ai_post_run_cf_nvidia_nemotron_3_120b_a12b,insert,,Execute @cf/nvidia/nemotron-3-120b-a12b model. ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/gpt-oss-120b,workers-ai-post-run-cf-openai-gpt-oss-120b,workers_ai_post_run_cf_openai_gpt_oss_120b,post,,Workers AI Text Generation,workers_ai_text_generation,gpt_oss_120b,workers_ai_post_run_cf_openai_gpt_oss_120b,insert,,Execute @cf/openai/gpt-oss-120b model. ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/gpt-oss-20b,workers-ai-post-run-cf-openai-gpt-oss-20b,workers_ai_post_run_cf_openai_gpt_oss_20b,post,,Workers AI Text Generation,workers_ai_text_generation,gpt_oss_20b,workers_ai_post_run_cf_openai_gpt_oss_20b,insert,,Execute @cf/openai/gpt-oss-20b model. -ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/whisper,workers-ai-post-run-cf-openai-whisper,workers_ai_post_run_cf_openai_whisper,post,,Workers AI Automatic Speech Recognition,workers_ai_automatic_speech_recognition,whisper,workers_ai_post_run_cf_openai_whisper,insert,,Execute @cf/openai/whisper model. +ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/whisper,workers-ai-post-run-cf-openai-whisper,workers_ai_post_run_cf_openai_whisper,post,,Workers AI Automatic Speech Recognition,workers_ai_automatic_speech_recognition,run,whisper,exec,,Execute @cf/openai/whisper model. ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/whisper-large-v3-turbo,workers-ai-post-run-cf-openai-whisper-large-v3-turbo,workers_ai_post_run_cf_openai_whisper_large_v3_turbo,post,,Workers AI Automatic Speech Recognition,workers_ai_automatic_speech_recognition,whisper_large_v3_turbo,workers_ai_post_run_cf_openai_whisper_large_v3_turbo,insert,,Execute @cf/openai/whisper-large-v3-turbo model. -ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en,workers-ai-post-run-cf-openai-whisper-tiny-en,workers_ai_post_run_cf_openai_whisper_tiny_en,post,,Workers AI Automatic Speech Recognition,workers_ai_automatic_speech_recognition,whisper_tiny_en,workers_ai_post_run_cf_openai_whisper_tiny_en,insert,,Execute @cf/openai/whisper-tiny-en model. +ai.yaml,/accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en,workers-ai-post-run-cf-openai-whisper-tiny-en,workers_ai_post_run_cf_openai_whisper_tiny_en,post,,Workers AI Automatic Speech Recognition,workers_ai_automatic_speech_recognition,run,whisper_tiny_en,exec,,Execute @cf/openai/whisper-tiny-en model. ai.yaml,/accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106,workers-ai-post-run-cf-openchat-openchat-3-5-0106,workers_ai_post_run_cf_openchat_openchat_3_5_0106,post,,Workers AI Text Generation,workers_ai_text_generation,openchat_3_5_0106,workers_ai_post_run_cf_openchat_openchat_3_5_0106,insert,,Execute @cf/openchat/openchat-3.5-0106 model. ai.yaml,/accounts/{account_id}/ai/run/@cf/pfnet/plamo-embedding-1b,workers-ai-post-run-cf-pfnet-plamo-embedding-1b,workers_ai_post_run_cf_pfnet_plamo_embedding_1b,post,,Workers AI Text Embeddings,workers_ai_text_embeddings,plamo_embedding_1b,workers_ai_post_run_cf_pfnet_plamo_embedding_1b,insert,,Execute @cf/pfnet/plamo-embedding-1b model. ai.yaml,/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat,workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat,workers_ai_post_run_cf_qwen_qwen1_5_0_5b_chat,post,,Workers AI Text Generation,workers_ai_text_generation,qwen1_5_0_5b_chat,workers_ai_post_run_cf_qwen_qwen1_5_0_5b_chat,insert,,Execute @cf/qwen/qwen1.5-0.5b-chat model. @@ -196,15 +196,15 @@ ai.yaml,/accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq ai.yaml,/accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq,workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq,workers_ai_post_run_hf_thebloke_zephyr_7b_beta_awq,post,,Workers AI Text Generation,workers_ai_text_generation,zephyr_7b_beta_awq,workers_ai_post_run_hf_thebloke_zephyr_7b_beta_awq,insert,,Execute @hf/thebloke/zephyr-7b-beta-awq model. ai.yaml,/accounts/{account_id}/ai/run/{model_name},workers-ai-post-run-model,workers_ai_post_run_model,post,,Workers AI,workers_ai,run,run,insert,,Execute AI model ai.yaml,/accounts/{account_id}/ai/tasks/search,workers-ai-search-task,workers_ai_search_task,get,,Workers AI,workers_ai,tasks,list,select,$.result,Task Search -ai.yaml,/accounts/{account_id}/ai/tomarkdown,workers-ai-post-to-markdown,workers_ai_post_to_markdown,post,,Workers AI,workers_ai,tomarkdown,workers_ai_post_to_markdown,insert,,Convert Files into Markdown -ai.yaml,/accounts/{account_id}/ai/tomarkdown/supported,workers-ai-get-to-markdown-supported,workers_ai_get_to_markdown_supported,get,,Workers AI,workers_ai,to_markdown,list,select,$.result,Get all converted formats supported -ai.yaml,/accounts/{account_id}/autorag/rags/{id}/ai-search,autorag-config-ai-search,autorag_config_ai_search,post,,AutoRAG RAG Search,auto_rag_rag_search,ai_search,autorag_config_ai_search,insert,,AI Search +ai.yaml,/accounts/{account_id}/ai/tomarkdown,workers-ai-post-to-markdown,workers_ai_post_to_markdown,post,,Workers AI,workers_ai,to_markdown,convert,select,$.result,Convert Files into Markdown +ai.yaml,/accounts/{account_id}/ai/tomarkdown/supported,workers-ai-get-to-markdown-supported,workers_ai_get_to_markdown_supported,get,,Workers AI,workers_ai,to_markdown_supported,list,select,$.result,Get all converted formats supported +ai.yaml,/accounts/{account_id}/autorag/rags/{id}/ai-search,autorag-config-ai-search,autorag_config_ai_search,post,,AutoRAG RAG Search,auto_rag_rag_search,ai_search,autorag_config_ai_search,select,$.result.data,AI Search ai.yaml,/accounts/{account_id}/autorag/rags/{id}/files,autorag-config-files,autorag_config_files,get,,AutoRAG RAG,auto_rag_rag,files,list,select,$.result,Files ai.yaml,/accounts/{account_id}/autorag/rags/{id}/jobs,autorag-config-list-jobs,autorag_config_list_jobs,get,,AutoRAG Jobs,auto_rag_jobs,jobs,list,select,$.result,List Jobs ai.yaml,/accounts/{account_id}/autorag/rags/{id}/jobs/{job_id},autorag-config-get-job,autorag_config_get_job,get,,AutoRAG Jobs,auto_rag_jobs,jobs,get,select,$.result,Get a Job Details ai.yaml,/accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}/logs,autorag-config-list-job-logs,autorag_config_list_job_logs,get,,AutoRAG Jobs,auto_rag_jobs,logs,list,select,$.result,List Job Logs -ai.yaml,/accounts/{account_id}/autorag/rags/{id}/search,autorag-config-search,autorag_config_search,post,,AutoRAG RAG Search,auto_rag_rag_search,search,autorag_config_search,insert,,Search -ai.yaml,/accounts/{account_id}/autorag/rags/{id}/sync,autorag-config-sync,autorag_config_sync,patch,,AutoRAG RAG,auto_rag_rag,sync,autorag_config_sync,update,,Sync +ai.yaml,/accounts/{account_id}/autorag/rags/{id}/search,autorag-config-search,autorag_config_search,post,,AutoRAG RAG Search,auto_rag_rag_search,search,autorag_config_search,select,$.result.data,Search +ai.yaml,/accounts/{account_id}/autorag/rags/{id}/sync,autorag-config-sync,autorag_config_sync,patch,,AutoRAG RAG,auto_rag_rag,jobs,sync,exec,,Sync ai_gateway.yaml,/accounts/{account_id}/ai-gateway/evaluation-types,aig-config-list-evaluators,aig_config_list_evaluators,get,,AI Gateway Evaluations,ai_gateway_evaluations,evaluation_types,list,select,$.result,List Evaluators ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways,aig-config-list-gateway,aig_config_list_gateway,get,,AI Gateway Gateways,ai_gateway_gateways,gateways,list,select,$.result,List Gateways ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways,aig-config-create-gateway,aig_config_create_gateway,post,,AI Gateway Gateways,ai_gateway_gateways,gateways,create,insert,,Create a new Gateway @@ -227,7 +227,7 @@ ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs,aig-config-create-providers,aig_config_create_providers,post,,AI Gateway Provider Configs,ai_gateway_provider_configs,provider_configs,create,insert,,Create a new Provider Configs ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id},aig-config-delete-providers,aig_config_delete_providers,delete,,AI Gateway Provider Configs,ai_gateway_provider_configs,provider_configs,aig_config_delete_providers,delete,,Delete a Provider Configs ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id},aig-config-update-providers,aig_config_update_providers,put,,AI Gateway Provider Configs,ai_gateway_provider_configs,provider_configs,aig_config_update_providers,replace,,Update a Provider Configs -ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes,aig-config-list-gateway-dynamic-routes,aig_config_list_gateway_dynamic_routes,get,,AI Gateway Dynamic Routes,ai_gateway_dynamic_routes,dynamic_routing,list,select,$.result,List all AI Gateway Dynamic Routes. +ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes,aig-config-list-gateway-dynamic-routes,aig_config_list_gateway_dynamic_routes,get,,AI Gateway Dynamic Routes,ai_gateway_dynamic_routes,dynamic_routing,list,select,$.data.routes,List all AI Gateway Dynamic Routes. ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes,aig-config-post-gateway-dynamic-route,aig_config_post_gateway_dynamic_route,post,,AI Gateway Dynamic Routes,ai_gateway_dynamic_routes,dynamic_routing,create,insert,,Create a new AI Gateway Dynamic Route. ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id},aig-config-delete-gateway-dynamic-route,aig_config_delete_gateway_dynamic_route,delete,,AI Gateway Dynamic Routes,ai_gateway_dynamic_routes,dynamic_routing,delete,delete,,Delete an AI Gateway Dynamic Route. ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id},aig-config-get-gateway-dynamic-route,aig_config_get_gateway_dynamic_route,get,,AI Gateway Dynamic Routes,ai_gateway_dynamic_routes,gateways_routes,get_by_account,select,$.result,Get an AI Gateway Dynamic Route. @@ -241,54 +241,54 @@ ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/url/{pro ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{id},aig-config-delete-gateway,aig_config_delete_gateway,delete,,AI Gateway Gateways,ai_gateway_gateways,gateways,delete,delete,,Delete a Gateway ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{id},aig-config-fetch-gateway,aig_config_fetch_gateway,get,,AI Gateway Gateways,ai_gateway_gateways,gateways,get,select,$.result,Fetch a Gateway ai_gateway.yaml,/accounts/{account_id}/ai-gateway/gateways/{id},aig-config-update-gateway,aig_config_update_gateway,put,,AI Gateway Gateways,ai_gateway_gateways,gateways,update,replace,,Update a Gateway -aisearch.yaml,/accounts/{account_id}/ai-search/instances,ai-search-list-instances,ai_search_list_instances,get,,AI Search Instances,ai_search_instances,instances,list_by_account_by_account,select,$.result,List instances. -aisearch.yaml,/accounts/{account_id}/ai-search/instances,ai-search-create-instance,ai_search_create_instance,post,,AI Search Instances,ai_search_instances,instances,create_by_account,insert,,Create new instance. -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id},ai-search-delete-instance,ai_search_delete_instance,delete,,AI Search Instances,ai_search_instances,instances,delete_by_account,delete,,Delete instance. -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id},ai-search-fetch-instance,ai_search_fetch_instance,get,,AI Search Instances,ai_search_instances,instances,get_by_account,select,$.result,Read instance. -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id},ai-search-update-instance,ai_search_update_instance,put,,AI Search Instances,ai_search_instances,instances,update_by_account,replace,,Update instance. -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/chat/completions,ai-search-instance-chat-completion,ai_search_instance_chat_completion,post,,AI Search Instances,ai_search_instances,chat_completions,chat_completions_by_account,insert,,Chat Completions -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs,ai-search-instance-list-jobs,ai_search_instance_list_jobs,get,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,list_by_account_by_account,select,$.result,List Jobs -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs,ai-search-instance-create-job,ai_search_instance_create_job,post,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,create_by_account,insert,,Create new job -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id},ai-search-instance-get-job,ai_search_instance_get_job,get,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,get_by_account,select,$.result,Get a Job Details -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id},ai-search-instance-change-job-status,ai_search_instance_change_job_status,patch,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,ai_search_instance_change_job_status,update,,Change Job Status -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs,ai-search-instance-list-job-logs,ai_search_instance_list_job_logs,get,,AI Search Instances Jobs,ai_search_instances_jobs,jobs_logs,list_by_account,select,$.result,List Job Logs -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/search,ai-search-instance-search,ai_search_instance_search,post,,AI Search Instances,ai_search_instances,instances_search,search_by_account,insert,,Search -aisearch.yaml,/accounts/{account_id}/ai-search/instances/{id}/stats,ai-search-stats,ai_search_stats,get,,AI Search Instances,ai_search_instances,instances_stats,list_by_account,select,$.result,Stats -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces,ai-search-list-namespaces,ai_search_list_namespaces,get,,AI Search Namespaces,ai_search_namespaces,namespaces,list,select,$.result,List namespaces. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces,ai-search-create-namespace,ai_search_create_namespace,post,,AI Search Namespaces,ai_search_namespaces,namespaces,create,insert,,Create namespace. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name},ai-search-delete-namespace,ai_search_delete_namespace,delete,,AI Search Namespaces,ai_search_namespaces,namespaces,delete,delete,,Delete namespace. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name},ai-search-fetch-namespace,ai_search_fetch_namespace,get,,AI Search Namespaces,ai_search_namespaces,namespaces,get,select,$.result,Read namespace. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name},ai-search-update-namespace,ai_search_update_namespace,put,,AI Search Namespaces,ai_search_namespaces,namespaces,update,replace,,Update namespace. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/chat/completions,ai-search-namespace-multi-instance-chat-completion,ai_search_namespace_multi_instance_chat_completion,post,,AI Search Account Search,ai_search_account_search,chat_completions,chat_completions,insert,,Multi-Instance Chat Completions -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances,ai-search-namespace-list-instances,ai_search_namespace_list_instances,get,,AI Search Instances,ai_search_instances,namespace_instances,list_by_account_by_account,select,$.result,List instances. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances,ai-search-namespace-create-instance,ai_search_namespace_create_instance,post,,AI Search Instances,ai_search_instances,namespace_instances,create_by_account,insert,,Create new instance. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-namespace-delete-instance,ai_search_namespace_delete_instance,delete,,AI Search Instances,ai_search_instances,namespace_instances,delete_by_account,delete,,Delete instance. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-namespace-fetch-instance,ai_search_namespace_fetch_instance,get,,AI Search Instances,ai_search_instances,namespace_instances,get_by_account,select,$.result,Read instance. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-move-instance,ai_search_move_instance,patch,,AI Search Namespaces,ai_search_namespaces,instances,ai_search_move_instance,exec,,Move an instance to a different namespace. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-namespace-update-instance,ai_search_namespace_update_instance,put,,AI Search Instances,ai_search_instances,namespace_instances,update_by_account,replace,,Update instance. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions,ai-search-namespace-instance-chat-completion,ai_search_namespace_instance_chat_completion,post,,AI Search Instances,ai_search_instances,namespace_instance_chat_completions,chat_completions_by_account,insert,,Chat Completions -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items,ai-search-namespace-instance-list-items,ai_search_namespace_instance_list_items,get,,AI Search Instances Items,ai_search_instances_items,instances_items,list_by_account,select,$.result,Items List. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items,ai-search-namespace-instance-upload-item,ai_search_namespace_instance_upload_item,post,,AI Search Instances Items,ai_search_instances_items,items,upload,insert,,Upload Item. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items,ai-search-namespace-instance-create-or-update-item,ai_search_namespace_instance_create_or_update_item,put,,AI Search Instances Items,ai_search_instances_items,items,create_or_update,replace,,Create or Update Item. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id},ai-search-namespace-instance-delete-item,ai_search_namespace_instance_delete_item,delete,,AI Search Instances Items,ai_search_instances_items,items,delete,delete,,Delete Item. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id},ai-search-namespace-instance-get-item,ai_search_namespace_instance_get_item,get,,AI Search Instances Items,ai_search_instances_items,items,get,select,$.result,Get Item. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id},ai-search-namespace-instance-sync-item,ai_search_namespace_instance_sync_item,patch,,AI Search Instances Items,ai_search_instances_items,items,sync,update,,Sync Item. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks,ai-search-namespace-instance-list-item-chunks,ai_search_namespace_instance_list_item_chunks,get,,AI Search Instances Items,ai_search_instances_items,item_chunks,list,select,$.result,List Item Chunks. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download,ai-search-namespace-instance-get-item-content,ai_search_namespace_instance_get_item_content,get,,AI Search Instances Items,ai_search_instances_items,items_download,list_by_account,select,,Download Item Content. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs,ai-search-namespace-instance-logs-item,ai_search_namespace_instance_logs_item,get,,AI Search Instances Items,ai_search_instances_items,item_logs,list,select,$.result,Item Logs. -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs,ai-search-namespace-instance-list-jobs,ai_search_namespace_instance_list_jobs,get,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_jobs,list_by_account_by_account,select,$.result,List Jobs -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs,ai-search-namespace-instance-create-job,ai_search_namespace_instance_create_job,post,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_jobs,create_by_account,insert,,Create new job -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id},ai-search-namespace-instance-get-job,ai_search_namespace_instance_get_job,get,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_jobs,get_by_account,select,$.result,Get a Job Details -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id},ai-search-namespace-instance-change-job-status,ai_search_namespace_instance_change_job_status,patch,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,update,update,,Change Job Status -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs,ai-search-namespace-instance-list-job-logs,ai_search_namespace_instance_list_job_logs,get,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_job_logs,list_by_account,select,$.result,List Job Logs -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search,ai-search-namespace-instance-search,ai_search_namespace_instance_search,post,,AI Search Instances,ai_search_instances,namespaces_instance_search,search_by_account,insert,,Search -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats,ai-search-namespace-stats,ai_search_namespace_stats,get,,AI Search Instances,ai_search_instances,namespaces_instance_stats,list_by_account,select,$.result,Stats -aisearch.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/search,ai-search-namespace-multi-instance-search,ai_search_namespace_multi_instance_search,post,,AI Search Account Search,ai_search_account_search,namespaces_search,search,insert,,Multi-Instance Search -aisearch.yaml,/accounts/{account_id}/ai-search/tokens,ai-search-list-tokens,ai_search_list_tokens,get,,AI Search Tokens,ai_search_tokens,tokens,list,select,$.result,List tokens. -aisearch.yaml,/accounts/{account_id}/ai-search/tokens,ai-search-create-tokens,ai_search_create_tokens,post,,AI Search Tokens,ai_search_tokens,tokens,create,insert,,Create token. -aisearch.yaml,/accounts/{account_id}/ai-search/tokens/{id},ai-search-delete-tokens,ai_search_delete_tokens,delete,,AI Search Tokens,ai_search_tokens,tokens,delete,delete,,Delete token. -aisearch.yaml,/accounts/{account_id}/ai-search/tokens/{id},ai-search-fetch-tokens,ai_search_fetch_tokens,get,,AI Search Tokens,ai_search_tokens,tokens,get,select,$.result,Read token. -aisearch.yaml,/accounts/{account_id}/ai-search/tokens/{id},ai-search-update-tokens,ai_search_update_tokens,put,,AI Search Tokens,ai_search_tokens,tokens,update,replace,,Update token. +ai_search.yaml,/accounts/{account_id}/ai-search/instances,ai-search-list-instances,ai_search_list_instances,get,,AI Search Instances,ai_search_instances,instances,list_by_account_by_account,select,$.result,List instances. +ai_search.yaml,/accounts/{account_id}/ai-search/instances,ai-search-create-instance,ai_search_create_instance,post,,AI Search Instances,ai_search_instances,instances,create_by_account,insert,,Create new instance. +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id},ai-search-delete-instance,ai_search_delete_instance,delete,,AI Search Instances,ai_search_instances,instances,delete_by_account,delete,,Delete instance. +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id},ai-search-fetch-instance,ai_search_fetch_instance,get,,AI Search Instances,ai_search_instances,instances,get_by_account,select,$.result,Read instance. +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id},ai-search-update-instance,ai_search_update_instance,put,,AI Search Instances,ai_search_instances,instances,update_by_account,replace,,Update instance. +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/chat/completions,ai-search-instance-chat-completion,ai_search_instance_chat_completion,post,,AI Search Instances,ai_search_instances,chat_completions,chat_completions_by_account,select,$.choices,Chat Completions +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs,ai-search-instance-list-jobs,ai_search_instance_list_jobs,get,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,list_by_account_by_account,select,$.result,List Jobs +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs,ai-search-instance-create-job,ai_search_instance_create_job,post,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,create_by_account,insert,,Create new job +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id},ai-search-instance-get-job,ai_search_instance_get_job,get,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,get_by_account,select,$.result,Get a Job Details +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id},ai-search-instance-change-job-status,ai_search_instance_change_job_status,patch,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,ai_search_instance_change_job_status,update,,Change Job Status +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs,ai-search-instance-list-job-logs,ai_search_instance_list_job_logs,get,,AI Search Instances Jobs,ai_search_instances_jobs,jobs_logs,list_by_account,select,$.result,List Job Logs +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/search,ai-search-instance-search,ai_search_instance_search,post,,AI Search Instances,ai_search_instances,instances_search,search_by_account,select,$.result.chunks,Search +ai_search.yaml,/accounts/{account_id}/ai-search/instances/{id}/stats,ai-search-stats,ai_search_stats,get,,AI Search Instances,ai_search_instances,instances_stats,list_by_account,select,$.result,Stats +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces,ai-search-list-namespaces,ai_search_list_namespaces,get,,AI Search Namespaces,ai_search_namespaces,namespaces,list,select,$.result,List namespaces. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces,ai-search-create-namespace,ai_search_create_namespace,post,,AI Search Namespaces,ai_search_namespaces,namespaces,create,insert,,Create namespace. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name},ai-search-delete-namespace,ai_search_delete_namespace,delete,,AI Search Namespaces,ai_search_namespaces,namespaces,delete,delete,,Delete namespace. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name},ai-search-fetch-namespace,ai_search_fetch_namespace,get,,AI Search Namespaces,ai_search_namespaces,namespaces,get,select,$.result,Read namespace. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name},ai-search-update-namespace,ai_search_update_namespace,put,,AI Search Namespaces,ai_search_namespaces,namespaces,update,replace,,Update namespace. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/chat/completions,ai-search-namespace-multi-instance-chat-completion,ai_search_namespace_multi_instance_chat_completion,post,,AI Search Account Search,ai_search_account_search,chat_completions,chat_completions,select,$.choices,Multi-Instance Chat Completions +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances,ai-search-namespace-list-instances,ai_search_namespace_list_instances,get,,AI Search Instances,ai_search_instances,namespace_instances,list_by_account_by_account,select,$.result,List instances. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances,ai-search-namespace-create-instance,ai_search_namespace_create_instance,post,,AI Search Instances,ai_search_instances,namespace_instances,create_by_account,insert,,Create new instance. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-namespace-delete-instance,ai_search_namespace_delete_instance,delete,,AI Search Instances,ai_search_instances,namespace_instances,delete_by_account,delete,,Delete instance. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-namespace-fetch-instance,ai_search_namespace_fetch_instance,get,,AI Search Instances,ai_search_instances,namespace_instances,get_by_account,select,$.result,Read instance. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-move-instance,ai_search_move_instance,patch,,AI Search Namespaces,ai_search_namespaces,instances,ai_search_move_instance,exec,,Move an instance to a different namespace. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id},ai-search-namespace-update-instance,ai_search_namespace_update_instance,put,,AI Search Instances,ai_search_instances,namespace_instances,update_by_account,replace,,Update instance. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions,ai-search-namespace-instance-chat-completion,ai_search_namespace_instance_chat_completion,post,,AI Search Instances,ai_search_instances,namespace_instance_chat_completions,chat_completions_by_account,select,$.choices,Chat Completions +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items,ai-search-namespace-instance-list-items,ai_search_namespace_instance_list_items,get,,AI Search Instances Items,ai_search_instances_items,instances_items,list_by_account,select,$.result,Items List. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items,ai-search-namespace-instance-upload-item,ai_search_namespace_instance_upload_item,post,,AI Search Instances Items,ai_search_instances_items,items,upload,insert,,Upload Item. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items,ai-search-namespace-instance-create-or-update-item,ai_search_namespace_instance_create_or_update_item,put,,AI Search Instances Items,ai_search_instances_items,items,create_or_update,replace,,Create or Update Item. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id},ai-search-namespace-instance-delete-item,ai_search_namespace_instance_delete_item,delete,,AI Search Instances Items,ai_search_instances_items,items,delete,delete,,Delete Item. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id},ai-search-namespace-instance-get-item,ai_search_namespace_instance_get_item,get,,AI Search Instances Items,ai_search_instances_items,items,get,select,$.result,Get Item. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id},ai-search-namespace-instance-sync-item,ai_search_namespace_instance_sync_item,patch,,AI Search Instances Items,ai_search_instances_items,items,sync,update,,Sync Item. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks,ai-search-namespace-instance-list-item-chunks,ai_search_namespace_instance_list_item_chunks,get,,AI Search Instances Items,ai_search_instances_items,item_chunks,list,select,$.result,List Item Chunks. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download,ai-search-namespace-instance-get-item-content,ai_search_namespace_instance_get_item_content,get,,AI Search Instances Items,ai_search_instances_items,items_download,list_by_account,select,,Download Item Content. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs,ai-search-namespace-instance-logs-item,ai_search_namespace_instance_logs_item,get,,AI Search Instances Items,ai_search_instances_items,item_logs,list,select,$.result,Item Logs. +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs,ai-search-namespace-instance-list-jobs,ai_search_namespace_instance_list_jobs,get,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_jobs,list_by_account_by_account,select,$.result,List Jobs +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs,ai-search-namespace-instance-create-job,ai_search_namespace_instance_create_job,post,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_jobs,create_by_account,insert,,Create new job +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id},ai-search-namespace-instance-get-job,ai_search_namespace_instance_get_job,get,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_jobs,get_by_account,select,$.result,Get a Job Details +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id},ai-search-namespace-instance-change-job-status,ai_search_namespace_instance_change_job_status,patch,,AI Search Instances Jobs,ai_search_instances_jobs,jobs,update,update,,Change Job Status +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs,ai-search-namespace-instance-list-job-logs,ai_search_namespace_instance_list_job_logs,get,,AI Search Instances Jobs,ai_search_instances_jobs,namespaces_instance_job_logs,list_by_account,select,$.result,List Job Logs +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search,ai-search-namespace-instance-search,ai_search_namespace_instance_search,post,,AI Search Instances,ai_search_instances,namespaces_instance_search,search_by_account,select,$.result.chunks,Search +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats,ai-search-namespace-stats,ai_search_namespace_stats,get,,AI Search Instances,ai_search_instances,namespaces_instance_stats,list_by_account,select,$.result,Stats +ai_search.yaml,/accounts/{account_id}/ai-search/namespaces/{name}/search,ai-search-namespace-multi-instance-search,ai_search_namespace_multi_instance_search,post,,AI Search Account Search,ai_search_account_search,namespaces_search,search,select,$.result.chunks,Multi-Instance Search +ai_search.yaml,/accounts/{account_id}/ai-search/tokens,ai-search-list-tokens,ai_search_list_tokens,get,,AI Search Tokens,ai_search_tokens,tokens,list,select,$.result,List tokens. +ai_search.yaml,/accounts/{account_id}/ai-search/tokens,ai-search-create-tokens,ai_search_create_tokens,post,,AI Search Tokens,ai_search_tokens,tokens,create,insert,,Create token. +ai_search.yaml,/accounts/{account_id}/ai-search/tokens/{id},ai-search-delete-tokens,ai_search_delete_tokens,delete,,AI Search Tokens,ai_search_tokens,tokens,delete,delete,,Delete token. +ai_search.yaml,/accounts/{account_id}/ai-search/tokens/{id},ai-search-fetch-tokens,ai_search_fetch_tokens,get,,AI Search Tokens,ai_search_tokens,tokens,get,select,$.result,Read token. +ai_search.yaml,/accounts/{account_id}/ai-search/tokens/{id},ai-search-update-tokens,ai_search_update_tokens,put,,AI Search Tokens,ai_search_tokens,tokens,update,replace,,Update token. alerting.yaml,/accounts/{account_id}/alerting/v3/available_alerts,notification-alert-types-get-alert-types,notification_alert_types_get_alert_types,get,aaaAlertsResponseCollection,Notification Alert Types,notification_alert_types,available_alerts,list,select,$.result,Get Alert Types alerting.yaml,/accounts/{account_id}/alerting/v3/destinations/eligible,notification-mechanism-eligibility-get-delivery-mechanism-eligibility,notification_mechanism_eligibility_get_delivery_mechanism_eligibility,get,aaaSchemasResponseCollection,Notification Mechanism Eligibility,notification_mechanism_eligibility,eligability,list,select,,Get delivery mechanism eligibility alerting.yaml,/accounts/{account_id}/alerting/v3/destinations/pagerduty,notification-destinations-with-pager-duty-delete-pager-duty-services,notification_destinations_with_pager_duty_delete_pager_duty_services,delete,aaaSchemasApiResponseCommon,Notification destinations with PagerDuty,notification_destinations_with_pager_duty,pagerduty,delete,delete,,Delete PagerDuty Services @@ -370,7 +370,7 @@ billing.yaml,/accounts/{account_id}/pay-per-crawl/publisher/stripe,pay-per-crawl billing.yaml,/accounts/{account_id}/pay-per-crawl/publisher/stripe,pay-per-crawl.publisherGetStripeConfig,pay_per_crawl.publisherGetStripeConfig,get,payPerCrawlGetStripeConfigResponse,ppc_stripe,ppc_stripe,publisher_stripe,list,select,$.result,Gets the stripe config for a publisher billing.yaml,/accounts/{account_id}/pay-per-crawl/publisher/stripe,pay-per-crawl.publisherCreateStripeConfig,pay_per_crawl.publisherCreateStripeConfig,post,payPerCrawlCreateStripeConfigResponse,ppc_stripe,ppc_stripe,publisher_stripe,pay_per_crawl_publisher_create_stripe_config,insert,,Creates the stripe config for a publisher billing.yaml,/accounts/{account_id}/pay-per-crawl/zones_can_be_enabled,pay-per-crawl.setZonesCanBeEnabled,pay_per_crawl.setZonesCanBeEnabled,patch,payPerCrawlApiNoResultResponse,ppc_config,ppc_config,accounts,set_pay_per_crawl_zones,exec,,Set can_be_enabled setting on zones -billing.yaml,/accounts/{account_id}/pay-per-crawl/zones_can_be_enabled/query,pay-per-crawl.queryZonesCanBeEnabled,pay_per_crawl.queryZonesCanBeEnabled,post,payPerCrawlQueryZonesCanBeEnabledResponse,ppc_config,ppc_config,accounts,query_pay_per_crawl_zones,exec,,Gets the can_be_enabled zone setting +billing.yaml,/accounts/{account_id}/pay-per-crawl/zones_can_be_enabled/query,pay-per-crawl.queryZonesCanBeEnabled,pay_per_crawl.queryZonesCanBeEnabled,post,payPerCrawlQueryZonesCanBeEnabledResponse,ppc_config,ppc_config,accounts,query_pay_per_crawl_zones,select,$.result.zones,Gets the can_be_enabled zone setting billing.yaml,/zones/{zone_id}/pay-per-crawl/configuration,pay-per-crawl.getConfig,pay_per_crawl.getConfig,get,payPerCrawlGetConfigResponse,ppc_config,ppc_config,configuration,list,select,$.result,Get the pay-per-crawl config billing.yaml,/zones/{zone_id}/pay-per-crawl/configuration,pay-per-crawl.patchConfig,pay_per_crawl.patchConfig,patch,payPerCrawlGetConfigResponse,ppc_config,ppc_config,configuration,pay_per_crawl_patch_config,update,,Changes pay-per-crawl config for a zone billing.yaml,/zones/{zone_id}/pay-per-crawl/configuration,pay-per-crawl.createConfig,pay_per_crawl.createConfig,post,payPerCrawlGetConfigResponse,ppc_config,ppc_config,configuration,pay_per_crawl_create_config,insert,,Creates pay-per-crawl config for a zone @@ -399,7 +399,7 @@ brand_protection.yaml,/accounts/{account_id}/cloudforce-one/v2/brand-protection/ brand_protection.yaml,/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries,get_GetLogoQueries,get_GetLogoQueries,get,,Brand Protection,brand_protection,logos,list,select,,Get logo queries brand_protection.yaml,/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries,post_InsertLogoQuery,post_InsertLogoQuery,post,,Brand Protection,brand_protection,logo_queries,create,insert,,Insert logo query brand_protection.yaml,/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id},delete_DeleteLogoQuery,delete_DeleteLogoQuery,delete,,Brand Protection,brand_protection,logo_queries,delete_by_account,delete,,Delete logo query -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/content,brapi-post_Content,brapi_post_Content,post,,brapi,brapi,browser_rendering,create_content,exec,,Get HTML content. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/content,brapi-post_Content,brapi_post_Content,post,,brapi,brapi,content,get,select,,Get HTML content. browser_rendering.yaml,/accounts/{account_id}/browser-rendering/crawl,brapi-post_Crawl,brapi_post_Crawl,post,,brapi,brapi,crawl,create,insert,,Crawl websites. browser_rendering.yaml,/accounts/{account_id}/browser-rendering/crawl/{job_id},brapi-delete_CancelCrawl,brapi_delete_CancelCrawl,delete,,brapi,brapi,crawl,delete,delete,,Cancel a crawl job. browser_rendering.yaml,/accounts/{account_id}/browser-rendering/crawl/{job_id},brapi-get_CrawlResult,brapi_get_CrawlResult,get,,brapi,brapi,crawl,get,select,$.result,Get crawl result. @@ -415,16 +415,16 @@ browser_rendering.yaml,/accounts/{account_id}/browser-rendering/devtools/browser browser_rendering.yaml,/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/version,brapi-get_DevtoolsJsonVersion,brapi_get_DevtoolsJsonVersion,get,,brapi,brapi,json_version,list,select,,Get browser version metadata. browser_rendering.yaml,/accounts/{account_id}/browser-rendering/devtools/session,brapi-get_DevtoolsSessionList,brapi_get_DevtoolsSessionList,get,,brapi,brapi,session,list,select,$.result,List sessions. browser_rendering.yaml,/accounts/{account_id}/browser-rendering/devtools/session/{session_id},brapi-get_DevtoolsSessionDetails,brapi_get_DevtoolsSessionDetails,get,,brapi,brapi,session,get,select,,Get session details. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/json,brapi-post_Json,brapi_post_Json,post,,brapi,brapi,json,create,insert,,Get json. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/links,brapi-post_Links,brapi_post_Links,post,,brapi,brapi,browser_rendering,create_links,exec,,Get Links. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/markdown,brapi-post_Markdown,brapi_post_Markdown,post,,brapi,brapi,browser_rendering,create_markdown,exec,,Get markdown. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/pdf,brapi-post_Pdf,brapi_post_Pdf,post,,brapi,brapi,browser_rendering,create_pdf,exec,,Get PDF. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/scrape,brapi-post_Scrape,brapi_post_Scrape,post,,brapi,brapi,browser_rendering,create_scrape,exec,,Scrape elements. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/screenshot,brapi-post_Screenshot,brapi_post_Screenshot,post,,brapi,brapi,browser_rendering,create_screenshot,exec,,Get screenshot. -browser_rendering.yaml,/accounts/{account_id}/browser-rendering/snapshot,brapi-post_Snapshot,brapi_post_Snapshot,post,,brapi,brapi,browser_rendering,snapshot,exec,,Get HTML content and screenshot. -cache.yaml,/zones/{zone_id}/cache/cache_reserve,zone-cache-settings-get-cache-reserve-setting,zone_cache_settings_get_cache_reserve_setting,get,,Zone Cache Settings,zone_cache_settings,cache_cache_reserve,list,select,$.result,Get Cache Reserve setting +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/json,brapi-post_Json,brapi_post_Json,post,,brapi,brapi,json_extract,get,select,,Get json. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/links,brapi-post_Links,brapi_post_Links,post,,brapi,brapi,links,get,select,,Get Links. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/markdown,brapi-post_Markdown,brapi_post_Markdown,post,,brapi,brapi,markdown,get,select,,Get markdown. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/pdf,brapi-post_Pdf,brapi_post_Pdf,post,,brapi,brapi,pdf,get,select,,Get PDF. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/scrape,brapi-post_Scrape,brapi_post_Scrape,post,,brapi,brapi,scrape,get,select,$.result,Scrape elements. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/screenshot,brapi-post_Screenshot,brapi_post_Screenshot,post,,brapi,brapi,screenshot,get,select,,Get screenshot. +browser_rendering.yaml,/accounts/{account_id}/browser-rendering/snapshot,brapi-post_Snapshot,brapi_post_Snapshot,post,,brapi,brapi,snapshot,get,select,$.result,Get HTML content and screenshot. +cache.yaml,/zones/{zone_id}/cache/cache_reserve,zone-cache-settings-get-cache-reserve-setting,zone_cache_settings_get_cache_reserve_setting,get,,Zone Cache Settings,zone_cache_settings,cache_reserve,get,select,$.result,Get Cache Reserve setting cache.yaml,/zones/{zone_id}/cache/cache_reserve,zone-cache-settings-change-cache-reserve-setting,zone_cache_settings_change_cache_reserve_setting,patch,,Zone Cache Settings,zone_cache_settings,cache_reserve,edit,update,,Change Cache Reserve setting -cache.yaml,/zones/{zone_id}/cache/cache_reserve_clear,zone-cache-settings-get-cache-reserve-clear,zone_cache_settings_get_cache_reserve_clear,get,,Zone Cache Settings,zone_cache_settings,cache_cache_reserve_clear,list,select,$.result,Get Cache Reserve Clear +cache.yaml,/zones/{zone_id}/cache/cache_reserve_clear,zone-cache-settings-get-cache-reserve-clear,zone_cache_settings_get_cache_reserve_clear,get,,Zone Cache Settings,zone_cache_settings,cache_reserve,get_clear_status,exec,$.result,Get Cache Reserve Clear cache.yaml,/zones/{zone_id}/cache/cache_reserve_clear,zone-cache-settings-start-cache-reserve-clear,zone_cache_settings_start_cache_reserve_clear,post,,Zone Cache Settings,zone_cache_settings,cache_reserve,clear,exec,,Start Cache Reserve Clear cache.yaml,/zones/{zone_id}/cache/origin_cloud_regions,origin-cloud-regions-list,origin_cloud_regions_list,get,,Origin Cloud Regions,origin_cloud_regions,origin_cloud_regions,list,select,$.result,List origin cloud region mappings cache.yaml,/zones/{zone_id}/cache/origin_cloud_regions,origin-cloud-regions-upsert,origin_cloud_regions_upsert,patch,,Origin Cloud Regions,origin_cloud_regions,origin_cloud_regions,origin_cloud_regions_upsert,update,,Create or update an origin cloud region mapping @@ -469,13 +469,13 @@ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/aggregate,get_E cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/attackers,get_AttackerList,get_AttackerList,get,,Attacker,attacker,attackers,list,select,$.result,Lists attackers across multiple datasets cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories,get_CategoryList,get_CategoryList,get,,Category,category,events_categories,list,select,$.result,Lists categories across multiple datasets cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/catalog,get_CategoryListComplete,get_CategoryListComplete,get,,Category,category,categories_catalog,list,select,,Lists categories -cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/create,post_CategoryCreate,post_CategoryCreate,post,,Category,category,events_categories_create,create,insert,,Creates a new category +cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/create,post_CategoryCreate,post_CategoryCreate,post,,Category,category,events_categories,create,insert,,Creates a new category cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/{category_id},delete_CategoryDelete,delete_CategoryDelete,delete,,Category,category,categories,delete,delete,,Deletes a category cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/{category_id},get_CategoryRead,get_CategoryRead,get,,Category,category,categories,get,select,,Reads a category cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/{category_id},patch_CategoryUpdate,patch_CategoryUpdate,patch,,Category,category,categories,edit,update,,Updates a category cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/categories/{category_id},post_CategoryUpdate,post_CategoryUpdate,post,,Category,category,categories,post_category_update,insert,,Updates a category cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/countries,get_CountryRead,get_CountryRead,get,,Country,country,countries,list,select,$.result,Retrieves countries information for all countries -cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/create,post_EventCreate,post_EventCreate,post,,Event,event,events_create,create_by_account,exec,,Creates a new event +cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/create,post_EventCreate,post_EventCreate,post,,Event,event,events,create,insert,,Creates a new event cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/create/bulk,post_EventCreateBulk,post_EventCreateBulk,post,,Event,event,threat_events,bulk_create,insert,,Creates bulk events cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/create/bulk/relationships,post_DOSEventCreateBulkWithRelationships,post_DOSEventCreateBulkWithRelationships,post,,Event,event,relationships,post_dosevent_create_bulk_with_relationships,insert,,Creates bulk DOS event with relationships and indicators cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/dataset,get_DatasetList,get_DatasetList,get,,Dataset,dataset,datasets,list,select,$.result,Lists all datasets in an account @@ -524,11 +524,11 @@ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/queries/{query_ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/queries/{query_id},post_EventQueryUpdate,post_EventQueryUpdate,post,,Event,event,queries,post_event_query_update,insert,,Update a saved event query cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/raw/{dataset_id}/{event_id},get_EventRawReadDS,get_EventRawReadDS,get,,Event,event,events_raw,get_by_account,select,,Reads raw data for an event by UUID cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/relate/{event_id},delete_EventReferenceDelete,delete_EventReferenceDelete,delete,,Event,event,events,delete_relate,exec,,Removes an event reference -cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/relate/{event_id}/create,post_EventReferenceCreate,post_EventReferenceCreate,post,,Event,event,relate_create,create_by_account,exec,,Creates event references for a event +cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/relate/{event_id}/create,post_EventReferenceCreate,post_EventReferenceCreate,post,,Event,event,relationships,create_relate,exec,,Creates event references for a event cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/relationships/create,post_CreateEventRelationship,post_CreateEventRelationship,post,,Event,event,relationships,create,exec,,Create a relationship between two events cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags,get_TagList,get_TagList,get,,Tag,tag,events_tags,list_by_account,select,$.tags,Lists all tags (SoT) cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags/categories,get_TagCategoryList,get_TagCategoryList,get,,TagCategory,tag_category,tags_categories,list,select,$.categories,Lists all tag categories (SoT) -cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags/categories/create,post_TagCategoryCreate,post_TagCategoryCreate,post,,TagCategory,tag_category,tags_categories_create,create,exec,,Creates a new tag category (SoT) +cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags/categories/create,post_TagCategoryCreate,post_TagCategoryCreate,post,,TagCategory,tag_category,tags_categories,create,insert,,Creates a new tag category (SoT) cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid},delete_TagCategoryDelete,delete_TagCategoryDelete,delete,,TagCategory,tag_category,categories,delete_tag_category_delete,delete,,Deletes a tag category (SoT) cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid},patch_TagCategoryUpdate,patch_TagCategoryUpdate,patch,,TagCategory,tag_category,categories,patch_tag_category_update,update,,Updates a tag category (SoT) cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/tags/create,post_TagCreate,post_TagCreate,post,,Tag,tag,tags,create,insert,,Creates a new tag @@ -547,7 +547,7 @@ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/{event_id}/raw/ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/events/{event_id}/relationships,get_EventRelationships,get_EventRelationships,get,,Event,event,relationships,list,select,,Filter and list events related to specific event cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests,cloudforce-one-request-list,cloudforce_one_request_list,post,,Request for Information (RFI),request_for_information_rfi,cloudforce_one,create_requests,exec,,List Requests cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/constants,cloudforce-one-request-constants,cloudforce_one_request_constants,get,,Request for Information (RFI),request_for_information_rfi,requests_constants,list,select,$.result,"Get Request Priority, Status, and TLP constants" -cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/new,cloudforce-one-request-new,cloudforce_one_request_new,post,,Request for Information (RFI),request_for_information_rfi,requests_new,new_by_account,exec,,Create a New Request. +cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/new,cloudforce-one-request-new,cloudforce_one_request_new,post,,Request for Information (RFI),request_for_information_rfi,requests,create,insert,,Create a New Request. cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/priority,cloudforce-one-priority-list,cloudforce_one_priority_list,post,,Priority Intelligence Requirements (PIR),priority_intelligence_requirements_pir,requests,create_priority,exec,,List Priority Intelligence Requirements cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/priority/new,cloudforce-one-priority-new,cloudforce_one_priority_new,post,,Priority Intelligence Requirements (PIR),priority_intelligence_requirements_pir,priority,new,exec,,Create a New Priority Intelligence Requirement cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/priority/quota,cloudforce-one-priority-quota,cloudforce_one_priority_quota,get,,Priority Intelligence Requirements (PIR),priority_intelligence_requirements_pir,priority,list,select,$.result,Get Priority Intelligence Requirement Quota @@ -565,7 +565,7 @@ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/ cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id},cloudforce-one-request-asset-get,cloudforce_one_request_asset_get,get,,Request for Information (RFI),request_for_information_rfi,assets,get,select,$.result,Get a Request Asset cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id},cloudforce-one-request-asset-update,cloudforce_one_request_asset_update,put,,Request for Information (RFI),request_for_information_rfi,assets,update,replace,,Update a Request Asset cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/message,cloudforce-one-request-message-list,cloudforce_one_request_message_list,post,,Request for Information (RFI),request_for_information_rfi,requests,create_message,exec,,List Request Messages -cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new,cloudforce-one-request-message-new,cloudforce_one_request_message_new,post,,Request for Information (RFI),request_for_information_rfi,message_new,new_by_account,exec,,Create a New Request Message +cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new,cloudforce-one-request-message-new,cloudforce_one_request_message_new,post,,Request for Information (RFI),request_for_information_rfi,message,create,insert,,Create a New Request Message cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id},cloudforce-one-request-message-delete,cloudforce_one_request_message_delete,delete,cloudforceOneRequestsApiResponseCommon,Request for Information (RFI),request_for_information_rfi,message,delete,delete,,Delete a Request Message cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id},cloudforce-one-request-message-update,cloudforce_one_request_message_update,put,,Request for Information (RFI),request_for_information_rfi,message,update,replace,,Update a Request Message cloudforce_one.yaml,/accounts/{account_id}/cloudforce-one/rules,cloudforce-one-delete-all-rules,cloudforce_one_delete_all_rules,delete,cloudforceOneDeleteAllResponse,Rules,rules,rules,cloudforce_one_delete_all_rules,delete,,Delete all rules @@ -597,8 +597,8 @@ connectivity.yaml,/accounts/{account_id}/connectivity/directory/services,connect connectivity.yaml,/accounts/{account_id}/connectivity/directory/services/{service_id},connectivity-services-delete,connectivity_services_delete,delete,,Connectivity Services,connectivity_services,services,delete,delete,,Delete Workers VPC connectivity service connectivity.yaml,/accounts/{account_id}/connectivity/directory/services/{service_id},connectivity-services-get,connectivity_services_get,get,,Connectivity Services,connectivity_services,services,get,select,$.result,Get Workers VPC connectivity service connectivity.yaml,/accounts/{account_id}/connectivity/directory/services/{service_id},connectivity-services-put,connectivity_services_put,put,,Connectivity Services,connectivity_services,services,update,replace,,Update Workers VPC connectivity service -content_scanning.yaml,/zones/{zone_id}/content-upload-scan/disable,waf-content-scanning-disable,waf_content_scanning_disable,post,wafProductApiBundleSchemasApiResponseCommon,Content Scanning,content_scanning,content_upload_scan,disable,exec,,Disable Content Scanning -content_scanning.yaml,/zones/{zone_id}/content-upload-scan/enable,waf-content-scanning-enable,waf_content_scanning_enable,post,wafProductApiBundleSchemasApiResponseCommon,Content Scanning,content_scanning,content_upload_scan,enable,exec,,Enable Content Scanning +content_scanning.yaml,/zones/{zone_id}/content-upload-scan/disable,waf-content-scanning-disable,waf_content_scanning_disable,post,wafProductApiBundleSchemasApiResponseCommon,Content Scanning,content_scanning,settings,disable,exec,,Disable Content Scanning +content_scanning.yaml,/zones/{zone_id}/content-upload-scan/enable,waf-content-scanning-enable,waf_content_scanning_enable,post,wafProductApiBundleSchemasApiResponseCommon,Content Scanning,content_scanning,settings,enable,exec,,Enable Content Scanning content_scanning.yaml,/zones/{zone_id}/content-upload-scan/payloads,waf-content-scanning-list-custom-scan-expressions,waf_content_scanning_list_custom_scan_expressions,get,wafProductApiBundleResponseCustomScanCollection,Content Scanning,content_scanning,payloads,list,select,$.result,List Existing Custom Scan Expressions content_scanning.yaml,/zones/{zone_id}/content-upload-scan/payloads,waf-content-scanning-add-custom-scan-expressions,waf_content_scanning_add_custom_scan_expressions,post,wafProductApiBundleResponseCustomScanCollection,Content Scanning,content_scanning,payloads,waf_content_scanning_add_custom_scan_expressions,insert,,Add Custom Scan Expressions content_scanning.yaml,/zones/{zone_id}/content-upload-scan/payloads/{expression_id},waf-content-scanning-delete-custom-scan-expressions,waf_content_scanning_delete_custom_scan_expressions,delete,wafProductApiBundleResponseCustomScanCollection,Content Scanning,content_scanning,payloads,waf_content_scanning_delete_custom_scan_expressions,delete,,Delete a Custom Scan Expression @@ -647,7 +647,7 @@ d1.yaml,/accounts/{account_id}/d1/database/{database_id},d1-update-partial-datab d1.yaml,/accounts/{account_id}/d1/database/{database_id},d1-update-database,d1_update_database,put,,D1,d1,database,update,replace,,Update D1 Database d1.yaml,/accounts/{account_id}/d1/database/{database_id}/export,d1-export-database,d1_export_database,post,,D1,d1,database,export,exec,,Export D1 Database as SQL d1.yaml,/accounts/{account_id}/d1/database/{database_id}/import,d1-import-database,d1_import_database,post,,D1,d1,database,import,exec,,Import SQL into your D1 Database -d1.yaml,/accounts/{account_id}/d1/database/{database_id}/query,d1-query-database,d1_query_database,post,,D1,d1,database_query,query,insert,$.result,Query D1 Database +d1.yaml,/accounts/{account_id}/d1/database/{database_id}/query,d1-query-database,d1_query_database,post,,D1,d1,database_query,query,select,$.result,Query D1 Database d1.yaml,/accounts/{account_id}/d1/database/{database_id}/raw,d1-raw-database-query,d1_raw_database_query,post,,D1,d1,database,create_raw,exec,,Raw D1 Database query d1.yaml,/accounts/{account_id}/d1/database/{database_id}/time_travel/bookmark,d1-time-travel-get-bookmark,d1_time_travel_get_bookmark,get,,D1,d1,time_travel,list,select,$.result,Get D1 database bookmark d1.yaml,/accounts/{account_id}/d1/database/{database_id}/time_travel/restore,d1-time-travel-restore,d1_time_travel_restore,post,,D1,d1,time_travel,restore,exec,,Restore D1 Database to a bookmark or point in time @@ -696,7 +696,7 @@ diagnostics.yaml,/accounts/{account_id}/diagnostics/endpoint-healthchecks,diagno diagnostics.yaml,/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id},diagnostics-endpoint-healthcheck-delete,diagnostics_endpoint_healthcheck_delete,delete,magicTransitApiResponseCommon,Endpoint Health Checks,endpoint_health_checks,endpoint_healthchecks,delete,delete,,Delete Endpoint Health Check diagnostics.yaml,/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id},diagnostics-endpoint-healthcheck-get,diagnostics_endpoint_healthcheck_get,get,magicTransitEndpointHealthCheckResponseSingle,Endpoint Health Checks,endpoint_health_checks,endpoint_healthchecks,get,select,$.result,Get Endpoint Health Check diagnostics.yaml,/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id},diagnostics-endpoint-healthcheck-update,diagnostics_endpoint_healthcheck_update,put,magicTransitEndpointHealthCheckResponseSingle,Endpoint Health Checks,endpoint_health_checks,endpoint_healthchecks,update,replace,,Update Endpoint Health Check -diagnostics.yaml,/accounts/{account_id}/diagnostics/traceroute,diagnostics-traceroute,diagnostics_traceroute,post,magicTransitTracerouteResponseCollection,Diagnostics,diagnostics,diagnostics,create_traceroute,exec,,Traceroute +diagnostics.yaml,/accounts/{account_id}/diagnostics/traceroute,diagnostics-traceroute,diagnostics_traceroute,post,magicTransitTracerouteResponseCollection,Diagnostics,diagnostics,diagnostics,create_traceroute,select,$.result,Traceroute dns.yaml,/accounts/{account_id}/dns_records/usage,get_accounts_account_id_dns_records_usage,get_accounts_account_id_dns_records_usage,get,dnsRecordsDnsResponseAccountUsage,,,usage,list_by_account,select,$.result,Get DNS Record Usage for account or zone dns.yaml,/accounts/{account_id}/dns_settings,dns-settings-for-an-account-list-dns-settings,dns_settings_for_an_account_list_dns_settings,get,dnsSettingsDnsResponseSingle,DNS Settings for an Account,dns_settings_for_an_account,account,list,select,$.result,Show DNS Settings dns.yaml,/accounts/{account_id}/dns_settings,dns-settings-for-an-account-update-dns-settings,dns_settings_for_an_account_update_dns_settings,patch,dnsSettingsDnsResponseSingle,DNS Settings for an Account,dns_settings_for_an_account,account,edit,update,,Update DNS Settings @@ -721,7 +721,7 @@ dns.yaml,/accounts/{account_id}/secondary_dns/tsigs/{tsig_id},secondary-dns-(-ts dns.yaml,/accounts/{account_id}/secondary_dns/tsigs/{tsig_id},secondary-dns-(-tsig)-tsig-details,secondary_dns_(_tsig)_tsig_details,get,secondaryDnsSingleResponse,Secondary DNS (TSIG),secondary_dns_tsig,tsigs,get,select,$.result,TSIG Details dns.yaml,/accounts/{account_id}/secondary_dns/tsigs/{tsig_id},secondary-dns-(-tsig)-update-tsig,secondary_dns_(_tsig)_update_tsig,put,secondaryDnsSingleResponse,Secondary DNS (TSIG),secondary_dns_tsig,tsigs,update,replace,,Update TSIG dns.yaml,/zones/{zone_id}/dns_analytics/report,dns-analytics-table,dns_analytics_table,get,,DNS Analytics,dns_analytics,reports,list,select,$.result.data,Table -dns.yaml,/zones/{zone_id}/dns_analytics/report/bytime,dns-analytics-by-time,dns_analytics_by_time,get,,DNS Analytics,dns_analytics,bytimes,list,select,$.result.data,By Time +dns.yaml,/zones/{zone_id}/dns_analytics/report/bytime,dns-analytics-by-time,dns_analytics_by_time,get,,DNS Analytics,dns_analytics,reports_by_times,list,select,$.result.data,By Time dns.yaml,/zones/{zone_id}/dns_records,dns-records-for-a-zone-list-dns-records,dns_records_for_a_zone_list_dns_records,get,dnsRecordsDnsResponseCollection,DNS Records for a Zone,dns_records_for_a_zone,zones_dns_records,list,select,$.result,List DNS Records dns.yaml,/zones/{zone_id}/dns_records,dns-records-for-a-zone-create-dns-record,dns_records_for_a_zone_create_dns_record,post,dnsRecordsDnsResponseSingle,DNS Records for a Zone,dns_records_for_a_zone,zones_dns_records,create,insert,,Create DNS Record dns.yaml,/zones/{zone_id}/dns_records/batch,dns-records-for-a-zone-batch-dns-records,dns_records_for_a_zone_batch_dns_records,post,dnsRecordsDnsResponseBatch,DNS Records for a Zone,dns_records_for_a_zone,dns_records,batch,exec,,Batch DNS Records @@ -761,7 +761,7 @@ dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id},dns-fire dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id},dns-firewall-dns-firewall-cluster-details,dns_firewall_dns_firewall_cluster_details,get,dnsFirewallDnsFirewallSingleResponse,DNS Firewall,dns_firewall,dns_firewall,get,select,$.result,DNS Firewall Cluster Details dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id},dns-firewall-update-dns-firewall-cluster,dns_firewall_update_dns_firewall_cluster,patch,dnsFirewallDnsFirewallSingleResponse,DNS Firewall,dns_firewall,dns_firewall,edit,update,,Update DNS Firewall Cluster dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report,dns-firewall-analytics-table,dns_firewall_analytics_table,get,,DNS Firewall Analytics,dns_firewall_analytics,reports,list,select,$.result.data,Table -dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime,dns-firewall-analytics-by-time,dns_firewall_analytics_by_time,get,,DNS Firewall Analytics,dns_firewall_analytics,bytimes,list,select,$.result.data,By Time +dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime,dns-firewall-analytics-by-time,dns_firewall_analytics_by_time,get,,DNS Firewall Analytics,dns_firewall_analytics,dimensions_and_metrics,list,select,$.result.data,By Time dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns,dns-firewall-show-dns-firewall-cluster-reverse-dns,dns_firewall_show_dns_firewall_cluster_reverse_dns,get,dnsFirewallDnsFirewallReverseDnsResponse_2,DNS Firewall,dns_firewall,reverse_dns,list,select,,Show DNS Firewall Cluster Reverse DNS dns_firewall.yaml,/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns,dns-firewall-update-dns-firewall-cluster-reverse-dns,dns_firewall_update_dns_firewall_cluster_reverse_dns,patch,dnsFirewallDnsFirewallReverseDnsResponse_2,DNS Firewall,dns_firewall,reverse_dns,edit,update,,Update DNS Firewall Cluster Reverse DNS durable_objects.yaml,/accounts/{account_id}/workers/durable_objects/namespaces,durable-objects-namespace-list-namespaces,durable_objects_namespace_list_namespaces,get,,Durable Objects Namespace,durable_objects_namespace,namespaces,list,select,$.result,List Namespaces @@ -789,13 +789,13 @@ email_routing.yaml,/zones/{zone_id}/email/routing/suppression,post_zones_zone_id email_routing.yaml,/zones/{zone_id}/email/routing/suppression/{suppression_id},delete_zones_zone_id_email_routing_suppression_suppression_id,delete_zones_zone_id_email_routing_suppression_suppression_id,delete,,,,suppression,delete_zones_zone_id_email_routing_suppression_suppression_id,delete,,Delete account or zone email suppression email_routing.yaml,/zones/{zone_id}/email/routing/suppression/{suppression_id},get_zones_zone_id_email_routing_suppression_suppression_id,get_zones_zone_id_email_routing_suppression_suppression_id,get,,,,suppression,get,select,,Get account or zone email suppression email_security.yaml,/accounts/{account_id}/email-security/investigate,email_security_investigate,email_security_investigate,get,,Email Security,email_security,investigate,list,select,$.result,Search email messages -email_security.yaml,/accounts/{account_id}/email-security/investigate/move,email_security_post_bulk_move,email_security_post_bulk_move,post,,Email Security,email_security,move,email_security_post_bulk_move,insert,,Move multiple messages +email_security.yaml,/accounts/{account_id}/email-security/investigate/move,email_security_post_bulk_move,email_security_post_bulk_move,post,,Email Security,email_security,investigate,bulk_move,exec,,Move multiple messages email_security.yaml,/accounts/{account_id}/email-security/investigate/preview,email_security_post_preview,email_security_post_preview,post,,Email Security,email_security,preview,create,insert,,Preview for non-detection messages email_security.yaml,/accounts/{account_id}/email-security/investigate/release,email_security_post_release,email_security_post_release,post,,Email Security,email_security,investigate,release,exec,,Release messages from quarantine email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id},email_security_get_message,email_security_get_message,get,,Email Security,email_security,investigate,get,select,$.result,Get message details email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/action_log,email_security_get_message_action_log,email_security_get_message_action_log,get,,Email Security,email_security,action_log,list,select,$.result,Get action log for a message email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/detections,email_security_get_message_detections,email_security_get_message_detections,get,,Email Security,email_security,detections,list,select,$.result,Get message detection details -email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/move,email_security_post_message_move,email_security_post_message_move,post,,Email Security,email_security,move,email_security_post_message_move,insert,,Move a message +email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/move,email_security_post_message_move,email_security_post_message_move,post,,Email Security,email_security,investigate,move_message,exec,,Move a message email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/preview,email_security_get_message_preview,email_security_get_message_preview,get,,Email Security,email_security,preview,list,select,$.result,Get email preview email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/raw,email_security_get_message_raw,email_security_get_message_raw,get,,Email Security,email_security,raw,list,select,$.result,Get raw email content email_security.yaml,/accounts/{account_id}/email-security/investigate/{investigate_id}/reclassify,email_security_post_reclassify,email_security_post_reclassify,post,,Email Security,email_security,investigate,reclassify,exec,,Change email classification @@ -962,8 +962,8 @@ iam.yaml,/accounts/{account_id}/sso_connectors/{sso_connector_id},delete-sso-con iam.yaml,/accounts/{account_id}/sso_connectors/{sso_connector_id},get-sso-connector,get_sso_connector,get,iamSsoConnectorResponse,SSO,sso,sso,get,select,$.result,Get single SSO connector iam.yaml,/accounts/{account_id}/sso_connectors/{sso_connector_id},update-sso-connector-state,update_sso_connector_state,patch,iamSsoConnectorResponse,SSO,sso,sso,update,update,,Update SSO connector state iam.yaml,/accounts/{account_id}/sso_connectors/{sso_connector_id}/begin_verification,begin-sso-connector-verification,begin_sso_connector_verification,post,iamApiResponseSingle,SSO,sso,sso,begin_verification,insert,,Begin SSO connector verification -images.yaml,/accounts/{account_id}/images/v1,cloudflare-images-list-images,cloudflare_images_list_images,get,imagesImagesListResponse,Cloudflare Images,cloudflare_images,v1,list,select,$.result.images,List images -images.yaml,/accounts/{account_id}/images/v1,cloudflare-images-upload-an-image-via-url,cloudflare_images_upload_an_image_via_url,post,imagesImageResponseSingle,Cloudflare Images,cloudflare_images,v1,create,insert,,Upload an image +images.yaml,/accounts/{account_id}/images/v1,cloudflare-images-list-images,cloudflare_images_list_images,get,imagesImagesListResponse,Cloudflare Images,cloudflare_images,images_v1,list,select,$.result.images,List images +images.yaml,/accounts/{account_id}/images/v1,cloudflare-images-upload-an-image-via-url,cloudflare_images_upload_an_image_via_url,post,imagesImageResponseSingle,Cloudflare Images,cloudflare_images,images_v1,create,insert,,Upload an image images.yaml,/accounts/{account_id}/images/v1/keys,cloudflare-images-keys-list-signing-keys,cloudflare_images_keys_list_signing_keys,get,imagesImageKeyResponseCollection,Cloudflare Images Keys,cloudflare_images_keys,keys,list,select,$.result.keys,List Signing Keys images.yaml,/accounts/{account_id}/images/v1/keys/{signing_key_name},cloudflare-images-keys-delete-signing-key,cloudflare_images_keys_delete_signing_key,delete,imagesImageKeyResponseCollection,Cloudflare Images Keys,cloudflare_images_keys,keys,delete,delete,,Delete Signing Key images.yaml,/accounts/{account_id}/images/v1/keys/{signing_key_name},cloudflare-images-keys-add-signing-key,cloudflare_images_keys_add_signing_key,put,imagesImageKeyResponseCollection,Cloudflare Images Keys,cloudflare_images_keys,keys,update,replace,,Create a new Signing Key @@ -974,11 +974,11 @@ images.yaml,/accounts/{account_id}/images/v1/variants/{variant_id},cloudflare-im images.yaml,/accounts/{account_id}/images/v1/variants/{variant_id},cloudflare-images-variants-variant-details,cloudflare_images_variants_variant_details,get,imagesImageVariantSimpleResponse,Cloudflare Images Variants,cloudflare_images_variants,variants,get,select,$.result,Variant details images.yaml,/accounts/{account_id}/images/v1/variants/{variant_id},cloudflare-images-variants-update-a-variant,cloudflare_images_variants_update_a_variant,patch,imagesImageVariantSimpleResponse,Cloudflare Images Variants,cloudflare_images_variants,variants,edit,update,,Update a variant images.yaml,/accounts/{account_id}/images/v1/variants/{variant_id}/flat,cloudflare-images-variants-variant-details-flat,cloudflare_images_variants_variant_details_flat,get,imagesImageVariantFlatResponse,Cloudflare Images Variants,cloudflare_images_variants,flat,list,select,$.result,Variant details (flat) -images.yaml,/accounts/{account_id}/images/v1/{image_id},cloudflare-images-delete-image,cloudflare_images_delete_image,delete,imagesDeletedResponse,Cloudflare Images,cloudflare_images,v1,delete,delete,,Delete image -images.yaml,/accounts/{account_id}/images/v1/{image_id},cloudflare-images-image-details,cloudflare_images_image_details,get,imagesImageResponseSingle,Cloudflare Images,cloudflare_images,v1,get,select,$.result,Image details -images.yaml,/accounts/{account_id}/images/v1/{image_id},cloudflare-images-update-image,cloudflare_images_update_image,patch,imagesImageResponseSingle,Cloudflare Images,cloudflare_images,v1,edit,update,,Update image +images.yaml,/accounts/{account_id}/images/v1/{image_id},cloudflare-images-delete-image,cloudflare_images_delete_image,delete,imagesDeletedResponse,Cloudflare Images,cloudflare_images,images_v1,delete,delete,,Delete image +images.yaml,/accounts/{account_id}/images/v1/{image_id},cloudflare-images-image-details,cloudflare_images_image_details,get,imagesImageResponseSingle,Cloudflare Images,cloudflare_images,images_v1,get,select,$.result,Image details +images.yaml,/accounts/{account_id}/images/v1/{image_id},cloudflare-images-update-image,cloudflare_images_update_image,patch,imagesImageResponseSingle,Cloudflare Images,cloudflare_images,images_v1,edit,update,,Update image images.yaml,/accounts/{account_id}/images/v1/{image_id}/blob,cloudflare-images-base-image,cloudflare_images_base_image,get,,Cloudflare Images,cloudflare_images,blobs,list,select,,Base image -images.yaml,/accounts/{account_id}/images/v2,cloudflare-images-list-images-v2,cloudflare_images_list_images_v2,get,imagesImagesListResponseV2,Cloudflare Images,cloudflare_images,v2,list,select,$.result,List images V2 +images.yaml,/accounts/{account_id}/images/v2,cloudflare-images-list-images-v2,cloudflare_images_list_images_v2,get,imagesImagesListResponseV2,Cloudflare Images,cloudflare_images,images,list,select,$.result,List images V2 images.yaml,/accounts/{account_id}/images/v2/direct_upload,cloudflare-images-create-authenticated-direct-upload-url-v-2,cloudflare_images_create_authenticated_direct_upload_url_v_2,post,imagesImageDirectUploadResponseV2,Cloudflare Images,cloudflare_images,images,create_direct_upload_v2,exec,,Create authenticated direct upload URL V2 intel.yaml,/accounts/{account_id}/intel/asn/{asn},asn-intelligence-get-asn-overview,asn_intelligence_get_asn_overview,get,intelAsnComponentsSchemasResponse,ASN Intelligence,asn_intelligence,asn,get,select,,Get ASN Overview. intel.yaml,/accounts/{account_id}/intel/asn/{asn}/subnets,asn-intelligence-get-asn-subnets,asn_intelligence_get_asn_subnets,get,,ASN Intelligence,asn_intelligence,subnets,list,select,,Get ASN Subnets @@ -992,7 +992,7 @@ intel.yaml,/accounts/{account_id}/intel/dns,passive-dns-by-ip-get-passive-dns-by intel.yaml,/accounts/{account_id}/intel/domain,domain-intelligence-get-domain-details,domain_intelligence_get_domain_details,get,intelSingleResponse,Domain Intelligence,domain_intelligence,domains,list,select,$.result,Get Domain Details intel.yaml,/accounts/{account_id}/intel/domain-history,domain-history-get-domain-history,domain_history_get_domain_history,get,intelResponse,Domain History,domain_history,domain_history,list,select,$.result,Get Domain History intel.yaml,/accounts/{account_id}/intel/domain/bulk,domain-intelligence-get-multiple-domain-details,domain_intelligence_get_multiple_domain_details,get,intelCollectionResponse,Domain Intelligence,domain_intelligence,bulks,list,select,$.result,Get Multiple Domain Details -intel.yaml,/accounts/{account_id}/intel/indicator-feeds,custom-indicator-feeds-get-indicator-feeds,custom_indicator_feeds_get_indicator_feeds,get,customIndicatorFeedsIndicatorFeedResponse,Custom Indicator Feeds,custom_indicator_feeds,intel_indicator_feeds,list_by_account,select,$.result,Get indicator feeds owned by this account +intel.yaml,/accounts/{account_id}/intel/indicator-feeds,custom-indicator-feeds-get-indicator-feeds,custom_indicator_feeds_get_indicator_feeds,get,customIndicatorFeedsIndicatorFeedResponse,Custom Indicator Feeds,custom_indicator_feeds,indicator_feeds,list,select,$.result,Get indicator feeds owned by this account intel.yaml,/accounts/{account_id}/intel/indicator-feeds,custom-indicator-feeds-create-indicator-feeds,custom_indicator_feeds_create_indicator_feeds,post,customIndicatorFeedsCreateFeedResponse,Custom Indicator Feeds,custom_indicator_feeds,indicator_feeds,create,insert,,Create new indicator feed intel.yaml,/accounts/{account_id}/intel/indicator-feeds/permissions/add,custom-indicator-feeds-add-permission,custom_indicator_feeds_add_permission,put,customIndicatorFeedsPermissionsResponse,Custom Indicator Feeds,custom_indicator_feeds,permissions,update_add,exec,,Grant permission to indicator feed intel.yaml,/accounts/{account_id}/intel/indicator-feeds/permissions/remove,custom-indicator-feeds-remove-permission,custom_indicator_feeds_remove_permission,put,customIndicatorFeedsPermissionsResponse,Custom Indicator Feeds,custom_indicator_feeds,permissions,update_remove,exec,,Revoke permission to indicator feed @@ -1095,11 +1095,11 @@ logpush.yaml,/accounts/{account_id}/logpush/jobs,post_accounts_account_id_logpus logpush.yaml,/accounts/{account_id}/logpush/jobs/{job_id},delete_accounts_account_id_logpush_jobs_job_id,delete_accounts_account_id_logpush_jobs_job_id,delete,,,,jobs,delete_by_account,delete,,Delete Logpush job logpush.yaml,/accounts/{account_id}/logpush/jobs/{job_id},get_accounts_account_id_logpush_jobs_job_id,get_accounts_account_id_logpush_jobs_job_id,get,logpushLogpushJobResponseSingle,,,jobs,get_by_account,select,$.result,Get Logpush job details logpush.yaml,/accounts/{account_id}/logpush/jobs/{job_id},put_accounts_account_id_logpush_jobs_job_id,put_accounts_account_id_logpush_jobs_job_id,put,logpushLogpushJobResponseSingle,,,jobs,update_by_account,replace,,Update Logpush job -logpush.yaml,/accounts/{account_id}/logpush/ownership,post_accounts_account_id_logpush_ownership,post_accounts_account_id_logpush_ownership,post,logpushGetOwnershipResponse,,,logpush_ownership,create_by_account,insert,,Get ownership challenge -logpush.yaml,/accounts/{account_id}/logpush/ownership/validate,post_accounts_account_id_logpush_ownership_validate,post_accounts_account_id_logpush_ownership_validate,post,logpushValidateOwnershipResponse,,,ownership_validate,validate_by_account,insert,,Validate ownership challenge -logpush.yaml,/accounts/{account_id}/logpush/validate/destination,post_accounts_account_id_logpush_validate_destination,post_accounts_account_id_logpush_validate_destination,post,logpushValidateResponse,,,validate_destination,destination_by_account,insert,,Validate destination -logpush.yaml,/accounts/{account_id}/logpush/validate/destination/exists,post_accounts_account_id_logpush_validate_destination_exists,post_accounts_account_id_logpush_validate_destination_exists,post,logpushDestinationExistsResponse,,,destination_exists,destination_exists_by_account,insert,,Check destination exists -logpush.yaml,/accounts/{account_id}/logpush/validate/origin,post_accounts_account_id_logpush_validate_origin,post_accounts_account_id_logpush_validate_origin,post,logpushValidateResponse,,,validate_origin,origin_by_account,insert,,Validate origin +logpush.yaml,/accounts/{account_id}/logpush/ownership,post_accounts_account_id_logpush_ownership,post_accounts_account_id_logpush_ownership,post,logpushGetOwnershipResponse,,,jobs,get_ownership_challenge_by_account,exec,,Get ownership challenge +logpush.yaml,/accounts/{account_id}/logpush/ownership/validate,post_accounts_account_id_logpush_ownership_validate,post_accounts_account_id_logpush_ownership_validate,post,logpushValidateOwnershipResponse,,,jobs,validate_ownership_challenge_by_account,exec,,Validate ownership challenge +logpush.yaml,/accounts/{account_id}/logpush/validate/destination,post_accounts_account_id_logpush_validate_destination,post_accounts_account_id_logpush_validate_destination,post,logpushValidateResponse,,,jobs,validate_destination_by_account,exec,,Validate destination +logpush.yaml,/accounts/{account_id}/logpush/validate/destination/exists,post_accounts_account_id_logpush_validate_destination_exists,post_accounts_account_id_logpush_validate_destination_exists,post,logpushDestinationExistsResponse,,,jobs,destination_exists_by_account,exec,,Check destination exists +logpush.yaml,/accounts/{account_id}/logpush/validate/origin,post_accounts_account_id_logpush_validate_origin,post_accounts_account_id_logpush_validate_origin,post,logpushValidateResponse,,,jobs,validate_origin_by_account,exec,,Validate origin logpush.yaml,/zones/{zone_id}/logpush/datasets/{dataset_id}/fields,get_zones_zone_id_logpush_datasets_dataset_id_fields,get_zones_zone_id_logpush_datasets_dataset_id_fields,get,logpushLogpushFieldResponseCollection,,,fields,list_by_zone,select,,List fields logpush.yaml,/zones/{zone_id}/logpush/datasets/{dataset_id}/jobs,get_zones_zone_id_logpush_datasets_dataset_id_jobs,get_zones_zone_id_logpush_datasets_dataset_id_jobs,get,logpushLogpushJobResponseCollection,,,datasets_jobs,list_by_zone,select,$.result,List Logpush jobs for a dataset logpush.yaml,/zones/{zone_id}/logpush/edge/jobs,get-zones-zone_id-logpush-edge-jobs,get_zones_zone_id_logpush_edge_jobs,get,logpushInstantLogsJobResponseCollection,Instant Logs jobs for a zone,instant_logs_jobs_for_a_zone,edge,list,select,$.result,List Instant Logs jobs @@ -1109,11 +1109,11 @@ logpush.yaml,/zones/{zone_id}/logpush/jobs,post_zones_zone_id_logpush_jobs,post_ logpush.yaml,/zones/{zone_id}/logpush/jobs/{job_id},delete_zones_zone_id_logpush_jobs_job_id,delete_zones_zone_id_logpush_jobs_job_id,delete,,,,jobs,delete_by_zone,delete,,Delete Logpush job logpush.yaml,/zones/{zone_id}/logpush/jobs/{job_id},get_zones_zone_id_logpush_jobs_job_id,get_zones_zone_id_logpush_jobs_job_id,get,logpushLogpushJobResponseSingle,,,jobs,get_by_zone,select,$.result,Get Logpush job details logpush.yaml,/zones/{zone_id}/logpush/jobs/{job_id},put_zones_zone_id_logpush_jobs_job_id,put_zones_zone_id_logpush_jobs_job_id,put,logpushLogpushJobResponseSingle,,,jobs,update_by_zone,replace,,Update Logpush job -logpush.yaml,/zones/{zone_id}/logpush/ownership,post_zones_zone_id_logpush_ownership,post_zones_zone_id_logpush_ownership,post,logpushGetOwnershipResponse,,,logpush_ownership,create_by_zone,insert,,Get ownership challenge -logpush.yaml,/zones/{zone_id}/logpush/ownership/validate,post_zones_zone_id_logpush_ownership_validate,post_zones_zone_id_logpush_ownership_validate,post,logpushValidateOwnershipResponse,,,ownership_validate,validate_by_zone,insert,,Validate ownership challenge -logpush.yaml,/zones/{zone_id}/logpush/validate/destination,post_zones_zone_id_logpush_validate_destination,post_zones_zone_id_logpush_validate_destination,post,logpushValidateResponse,,,validate_destination,destination_by_zone,insert,,Validate destination -logpush.yaml,/zones/{zone_id}/logpush/validate/destination/exists,post_zones_zone_id_logpush_validate_destination_exists,post_zones_zone_id_logpush_validate_destination_exists,post,logpushDestinationExistsResponse,,,destination_exists,destination_exists_by_zone,insert,,Check destination exists -logpush.yaml,/zones/{zone_id}/logpush/validate/origin,post_zones_zone_id_logpush_validate_origin,post_zones_zone_id_logpush_validate_origin,post,logpushValidateResponse,,,validate_origin,origin_by_zone,insert,,Validate origin +logpush.yaml,/zones/{zone_id}/logpush/ownership,post_zones_zone_id_logpush_ownership,post_zones_zone_id_logpush_ownership,post,logpushGetOwnershipResponse,,,jobs,get_ownership_challenge_by_zone,exec,,Get ownership challenge +logpush.yaml,/zones/{zone_id}/logpush/ownership/validate,post_zones_zone_id_logpush_ownership_validate,post_zones_zone_id_logpush_ownership_validate,post,logpushValidateOwnershipResponse,,,jobs,validate_ownership_challenge_by_zone,exec,,Validate ownership challenge +logpush.yaml,/zones/{zone_id}/logpush/validate/destination,post_zones_zone_id_logpush_validate_destination,post_zones_zone_id_logpush_validate_destination,post,logpushValidateResponse,,,jobs,validate_destination_by_zone,exec,,Validate destination +logpush.yaml,/zones/{zone_id}/logpush/validate/destination/exists,post_zones_zone_id_logpush_validate_destination_exists,post_zones_zone_id_logpush_validate_destination_exists,post,logpushDestinationExistsResponse,,,jobs,destination_exists_by_zone,exec,,Check destination exists +logpush.yaml,/zones/{zone_id}/logpush/validate/origin,post_zones_zone_id_logpush_validate_origin,post_zones_zone_id_logpush_validate_origin,post,logpushValidateResponse,,,jobs,validate_origin_by_zone,exec,,Validate origin logs.yaml,/accounts/{account_id}/logs/control/cmb/config,delete-accounts-account_id-logs-control-cmb-config,delete_accounts_account_id_logs_control_cmb_config,delete,,Logcontrol CMB config for an account,logcontrol_cmb_config_for_an_account,config,delete,delete,,Delete CMB config logs.yaml,/accounts/{account_id}/logs/control/cmb/config,get-accounts-account_id-logs-control-cmb-config,get_accounts_account_id_logs_control_cmb_config,get,logcontrolCmbConfigResponseSingle,Logcontrol CMB config for an account,logcontrol_cmb_config_for_an_account,config,list,select,$.result,Get CMB config logs.yaml,/accounts/{account_id}/logs/control/cmb/config,post-accounts-account_id-logs-control-cmb-config,post_accounts_account_id_logs_control_cmb_config,post,logcontrolCmbConfigResponseSingle,Logcontrol CMB config for an account,logcontrol_cmb_config_for_an_account,config,create,insert,,Update CMB config @@ -1122,7 +1122,7 @@ logs.yaml,/accounts/{account_id}/logs/explorer/datasets,post_accounts_account_id logs.yaml,/accounts/{account_id}/logs/explorer/datasets/available,get_accounts_account_id_logs_explorer_datasets_available,get_accounts_account_id_logs_explorer_datasets_available,get,lexAvailableDestinationListResponse,,,accounts_logs_explorer_datasets_available,list,select,$.result,List available account or zone datasets logs.yaml,/accounts/{account_id}/logs/explorer/datasets/{dataset_id},get_accounts_account_id_logs_explorer_datasets_dataset_id,get_accounts_account_id_logs_explorer_datasets_dataset_id,get,lexDatasetDetailResponse,,,accounts_logs_explorer_datasets,get,select,$.result,Get an account or zone dataset logs.yaml,/accounts/{account_id}/logs/explorer/datasets/{dataset_id},put_accounts_account_id_logs_explorer_datasets_dataset_id,put_accounts_account_id_logs_explorer_datasets_dataset_id,put,lexDatasetDetailResponse,,,accounts_logs_explorer_datasets,put_accounts_account_id_logs_explorer_datasets_dataset_id,replace,,Update an account or zone dataset -logs.yaml,/accounts/{account_id}/logs/explorer/query/sql,post_accounts_account_id_logs_explorer_query_sql,post_accounts_account_id_logs_explorer_query_sql,post,lexQueryResponse,,,accounts_logs_explorer_query_sql,create_sql,exec,,Run a log query +logs.yaml,/accounts/{account_id}/logs/explorer/query/sql,post_accounts_account_id_logs_explorer_query_sql,post_accounts_account_id_logs_explorer_query_sql,post,lexQueryResponse,,,accounts_logs_explorer_query_sql,create_sql,select,,Run a log query logs.yaml,/zones/{zone_id}/logs/control/retention/flag,get-zones-zone_id-logs-control-retention-flag,get_zones_zone_id_logs_control_retention_flag,get,logcontrolRetentionFlagResponseSingle,Logs Received,logs_received,retention,list,select,$.result,Get log retention flag logs.yaml,/zones/{zone_id}/logs/control/retention/flag,post-zones-zone_id-logs-control-retention-flag,post_zones_zone_id_logs_control_retention_flag,post,logcontrolRetentionFlagResponseSingle,Logs Received,logs_received,retention,create,insert,,Update log retention flag logs.yaml,/zones/{zone_id}/logs/explorer/datasets,get_zones_zone_id_logs_explorer_datasets,get_zones_zone_id_logs_explorer_datasets,get,lexDatasetSummaryListResponse,,,zones_logs_explorer_datasets,list,select,$.result,List account or zone datasets @@ -1130,7 +1130,7 @@ logs.yaml,/zones/{zone_id}/logs/explorer/datasets,post_zones_zone_id_logs_explor logs.yaml,/zones/{zone_id}/logs/explorer/datasets/available,get_zones_zone_id_logs_explorer_datasets_available,get_zones_zone_id_logs_explorer_datasets_available,get,lexAvailableDestinationListResponse,,,zones_logs_explorer_datasets_available,list,select,$.result,List available account or zone datasets logs.yaml,/zones/{zone_id}/logs/explorer/datasets/{dataset_id},get_zones_zone_id_logs_explorer_datasets_dataset_id,get_zones_zone_id_logs_explorer_datasets_dataset_id,get,lexDatasetDetailResponse,,,zones_logs_explorer_datasets,get,select,$.result,Get an account or zone dataset logs.yaml,/zones/{zone_id}/logs/explorer/datasets/{dataset_id},put_zones_zone_id_logs_explorer_datasets_dataset_id,put_zones_zone_id_logs_explorer_datasets_dataset_id,put,lexDatasetDetailResponse,,,zones_logs_explorer_datasets,put_zones_zone_id_logs_explorer_datasets_dataset_id,replace,,Update an account or zone dataset -logs.yaml,/zones/{zone_id}/logs/explorer/query/sql,post_zones_zone_id_logs_explorer_query_sql,post_zones_zone_id_logs_explorer_query_sql,post,lexQueryResponse,,,zones_logs_explorer_query_sql,create_sql,exec,,Run a log query +logs.yaml,/zones/{zone_id}/logs/explorer/query/sql,post_zones_zone_id_logs_explorer_query_sql,post_zones_zone_id_logs_explorer_query_sql,post,lexQueryResponse,,,zones_logs_explorer_query_sql,create_sql,select,,Run a log query logs.yaml,/zones/{zone_id}/logs/rayids/{ray_id},get-zones-zone_id-logs-rayids-ray_id,get_zones_zone_id_logs_rayids_ray_id,get,logshareLogsResponseJsonLines,Logs Received,logs_received,rayids,get,select,,Get logs RayIDs logs.yaml,/zones/{zone_id}/logs/received,get-zones-zone_id-logs-received,get_zones_zone_id_logs_received,get,logshareLogsResponseJsonLines,Logs Received,logs_received,received,list,select,,Get logs received logs.yaml,/zones/{zone_id}/logs/received/fields,get-zones-zone_id-logs-received-fields,get_zones_zone_id_logs_received_fields,get,logshareFieldsResponse,Logs Received,logs_received,fields,list,select,,List fields @@ -1333,13 +1333,13 @@ origin_tls_client_auth.yaml,/zones/{zone_id}/origin_tls_client_auth/settings,zon origin_tls_client_auth.yaml,/zones/{zone_id}/origin_tls_client_auth/settings,zone-level-authenticated-origin-pulls-set-enablement-for-zone,zone_level_authenticated_origin_pulls_set_enablement_for_zone,put,tlsCertificatesAndHostnamesEnabledResponse,Zone-Level Authenticated Origin Pulls,zone_level_authenticated_origin_pulls,settings,update,replace,,Set Enablement for Zone origin_tls_client_auth.yaml,/zones/{zone_id}/origin_tls_client_auth/{certificate_id},zone-level-authenticated-origin-pulls-delete-certificate,zone_level_authenticated_origin_pulls_delete_certificate,delete,tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseSingle,Zone-Level Authenticated Origin Pulls,zone_level_authenticated_origin_pulls,origin_tls_client_auth,delete,delete,,Delete Certificate origin_tls_client_auth.yaml,/zones/{zone_id}/origin_tls_client_auth/{certificate_id},zone-level-authenticated-origin-pulls-get-certificate-details,zone_level_authenticated_origin_pulls_get_certificate_details,get,tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseSingle,Zone-Level Authenticated Origin Pulls,zone_level_authenticated_origin_pulls,origin_tls_client_auth,get,select,$.result,Get Certificate Details -page_rules.yaml,/zones/{zone_id}/pagerules,page-rules-list-page-rules,page_rules_list_page_rules,get,,Page Rules,page_rules,pagerules,list,select,$.result,List Page Rules -page_rules.yaml,/zones/{zone_id}/pagerules,page-rules-create-a-page-rule,page_rules_create_a_page_rule,post,,Page Rules,page_rules,pagerules,create,insert,,Create a Page Rule +page_rules.yaml,/zones/{zone_id}/pagerules,page-rules-list-page-rules,page_rules_list_page_rules,get,,Page Rules,page_rules,page_rules,list,select,$.result,List Page Rules +page_rules.yaml,/zones/{zone_id}/pagerules,page-rules-create-a-page-rule,page_rules_create_a_page_rule,post,,Page Rules,page_rules,page_rules,create,insert,,Create a Page Rule page_rules.yaml,/zones/{zone_id}/pagerules/settings,available-page-rules-settings-list-available-page-rules-settings,available_page_rules_settings_list_available_page_rules_settings,get,,Available Page Rules settings,available_page_rules_settings,settings,list,select,,List available Page Rules settings -page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-delete-a-page-rule,page_rules_delete_a_page_rule,delete,zonesSchemasApiResponseSingleId,Page Rules,page_rules,pagerules,delete,delete,,Delete a Page Rule -page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-get-a-page-rule,page_rules_get_a_page_rule,get,,Page Rules,page_rules,pagerules,get,select,$.result,Get a Page Rule -page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-edit-a-page-rule,page_rules_edit_a_page_rule,patch,,Page Rules,page_rules,pagerules,edit,update,,Edit a Page Rule -page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-update-a-page-rule,page_rules_update_a_page_rule,put,,Page Rules,page_rules,pagerules,update,replace,,Update a Page Rule +page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-delete-a-page-rule,page_rules_delete_a_page_rule,delete,zonesSchemasApiResponseSingleId,Page Rules,page_rules,page_rules,delete,delete,,Delete a Page Rule +page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-get-a-page-rule,page_rules_get_a_page_rule,get,,Page Rules,page_rules,page_rules,get,select,$.result,Get a Page Rule +page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-edit-a-page-rule,page_rules_edit_a_page_rule,patch,,Page Rules,page_rules,page_rules,edit,update,,Edit a Page Rule +page_rules.yaml,/zones/{zone_id}/pagerules/{pagerule_id},page-rules-update-a-page-rule,page_rules_update_a_page_rule,put,,Page Rules,page_rules,page_rules,update,replace,,Update a Page Rule page_shield.yaml,/zones/{zone_id}/page_shield,page-shield-get-settings,page_shield_get_settings,get,,Page Shield,page_shield,page_shield,list,select,$.result,Get Page Shield settings page_shield.yaml,/zones/{zone_id}/page_shield,page-shield-update-settings,page_shield_update_settings,put,,Page Shield,page_shield,page_shield,update,replace,,Update Page Shield settings page_shield.yaml,/zones/{zone_id}/page_shield/connections,page-shield-list-connections,page_shield_list_connections,get,pageShieldListZoneConnectionsResponse,Page Shield,page_shield,connections,list,select,$.result,List Page Shield connections @@ -1371,8 +1371,8 @@ pages.yaml,/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_ pages.yaml,/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name},pages-domains-get-domain,pages_domains_get_domain,get,,Pages Domains,pages_domains,domains,get,select,$.result,Get domain pages.yaml,/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name},pages-domains-patch-domain,pages_domains_patch_domain,patch,,Pages Domains,pages_domains,domains,edit,update,,Patch domain pages.yaml,/accounts/{account_id}/pages/projects/{project_name}/purge_build_cache,pages-purge-build-cache,pages_purge_build_cache,post,,Pages Build Cache,pages_build_cache,projects,purge_build_cache,exec,,Purge build cache -pipelines.yaml,/accounts/{account_id}/pipelines,getV4AccountsByAccount_idPipelines_deprecated,getV4AccountsByAccount_idPipelines_deprecated,get,,workers_pipelines_other,workers_pipelines_other,accounts_pipelines,list,select,$.results,[DEPRECATED] List Pipelines -pipelines.yaml,/accounts/{account_id}/pipelines,postV4AccountsByAccount_idPipelines_deprecated,postV4AccountsByAccount_idPipelines_deprecated,post,,workers_pipelines_other,workers_pipelines_other,accounts_pipelines,create,insert,,[DEPRECATED] Create Pipeline +pipelines.yaml,/accounts/{account_id}/pipelines,getV4AccountsByAccount_idPipelines_deprecated,getV4AccountsByAccount_idPipelines_deprecated,get,,workers_pipelines_other,workers_pipelines_other,pipelines,list,select,$.results,[DEPRECATED] List Pipelines +pipelines.yaml,/accounts/{account_id}/pipelines,postV4AccountsByAccount_idPipelines_deprecated,postV4AccountsByAccount_idPipelines_deprecated,post,,workers_pipelines_other,workers_pipelines_other,pipelines,create,insert,,[DEPRECATED] Create Pipeline pipelines.yaml,/accounts/{account_id}/pipelines/v1/pipelines,getV4AccountsByAccount_idPipelinesV1Pipelines,getV4AccountsByAccount_idPipelinesV1Pipelines,get,,workers_pipelines_other,workers_pipelines_other,v1_pipelines,list,select,$.result,List Pipelines pipelines.yaml,/accounts/{account_id}/pipelines/v1/pipelines,postV4AccountsByAccount_idPipelinesV1Pipelines,postV4AccountsByAccount_idPipelinesV1Pipelines,post,,workers_pipelines_other,workers_pipelines_other,v1_pipelines,create_v1,insert,,Create Pipeline pipelines.yaml,/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id},deleteV4AccountsByAccount_idPipelinesV1PipelinesByPipeline_id,deleteV4AccountsByAccount_idPipelinesV1PipelinesByPipeline_id,delete,,workers_pipelines_other,workers_pipelines_other,pipelines,delete_v1,delete,,Delete Pipelines @@ -1388,7 +1388,7 @@ pipelines.yaml,/accounts/{account_id}/pipelines/v1/streams/{stream_id},getV4Acco pipelines.yaml,/accounts/{account_id}/pipelines/v1/streams/{stream_id},patchV4AccountsByAccount_idPipelinesV1StreamsByStream_id,patchV4AccountsByAccount_idPipelinesV1StreamsByStream_id,patch,,workers_pipelines_other,workers_pipelines_other,streams,update,update,,Update Stream pipelines.yaml,/accounts/{account_id}/pipelines/v1/validate_sql,postV4AccountsByAccount_idPipelinesV1Validate_sql,postV4AccountsByAccount_idPipelinesV1Validate_sql,post,,workers_pipelines_other,workers_pipelines_other,pipelines,validate_sql_v1,exec,,Validate SQL pipelines.yaml,/accounts/{account_id}/pipelines/{pipeline_name},deleteV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,deleteV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,delete,,workers_pipelines_other,workers_pipelines_other,pipelines,delete,delete,,[DEPRECATED] Delete Pipeline -pipelines.yaml,/accounts/{account_id}/pipelines/{pipeline_name},getV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,getV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,get,,workers_pipelines_other,workers_pipelines_other,accounts_pipelines,get_by_account,select,$.result,[DEPRECATED] Get Pipeline +pipelines.yaml,/accounts/{account_id}/pipelines/{pipeline_name},getV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,getV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,get,,workers_pipelines_other,workers_pipelines_other,pipelines,get,select,$.result,[DEPRECATED] Get Pipeline pipelines.yaml,/accounts/{account_id}/pipelines/{pipeline_name},putV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,putV4AccountsByAccount_idPipelinesByPipeline_name_deprecated,put,,workers_pipelines_other,workers_pipelines_other,pipelines,update,replace,,[DEPRECATED] Update Pipeline queues.yaml,/accounts/{account_id}/event_subscriptions/subscriptions,subscriptions-list,subscriptions_list,get,,Queue,queue,subscriptions,list,select,$.result,List Event Subscriptions queues.yaml,/accounts/{account_id}/event_subscriptions/subscriptions,subscriptions-create,subscriptions_create,post,,Queue,queue,subscriptions,create,insert,,Create Event Subscription @@ -1407,10 +1407,10 @@ queues.yaml,/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id},que queues.yaml,/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id},queues-get-consumer,queues_get_consumer,get,,Queue,queue,consumers,get,select,$.result,Get Queue Consumer queues.yaml,/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id},queues-update-consumer,queues_update_consumer,put,,Queue,queue,consumers,update,replace,,Update Queue Consumer queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages,queues-push-message,queues_push_message,post,,Queue,queue,queues,create_messages,exec,,Push Message -queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/ack,queues-ack-messages,queues_ack_messages,post,,Queue,queue,messages_ack,ack,exec,,Acknowledge + Retry Queue Messages +queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/ack,queues-ack-messages,queues_ack_messages,post,,Queue,queue,queues,ack_messages,exec,,Acknowledge + Retry Queue Messages queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/batch,queues-push-messages,queues_push_messages,post,,Queue,queue,queues,batch,exec,,Push Message Batch queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/preview,queues-preview-messages,queues_preview_messages,post,,Queue,queue,queues,preview,exec,,Preview Queue Messages -queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/preview/ack,queues-ack-preview-messages,queues_ack_preview_messages,post,,Queue,queue,preview_ack,ack,exec,,Delete Previewed Queue Messages +queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/preview/ack,queues-ack-preview-messages,queues_ack_preview_messages,post,,Queue,queue,queues,ack_preview_messages,exec,,Delete Previewed Queue Messages queues.yaml,/accounts/{account_id}/queues/{queue_id}/messages/pull,queues-pull-messages,queues_pull_messages,post,,Queue,queue,queues,pull,exec,,Pull Queue Messages queues.yaml,/accounts/{account_id}/queues/{queue_id}/metrics,queues-get-metrics,queues_get_metrics,get,mqQueueMetrics,Queue,queue,metrics,list,select,$.result,Get Queue Metrics queues.yaml,/accounts/{account_id}/queues/{queue_id}/purge,queues-purge-get,queues_purge_get,get,,Queue,queue,purge,list,select,$.result,Get Queue Purge Status @@ -1455,25 +1455,25 @@ r2.yaml,/accounts/{account_id}/slurper/jobs/{job_id}/logs,slurper-get-job-logs,s r2.yaml,/accounts/{account_id}/slurper/jobs/{job_id}/pause,slurper-pause-job,slurper_pause_job,put,,R2 Super Slurper,r2_super_slurper,jobs,pause,exec,,Pause a job r2.yaml,/accounts/{account_id}/slurper/jobs/{job_id}/progress,slurper-get-job-progress,slurper_get_job_progress,get,,R2 Super Slurper,r2_super_slurper,jobs_progress,list_by_account,select,$.result,Get job progress r2.yaml,/accounts/{account_id}/slurper/jobs/{job_id}/resume,slurper-resume-job,slurper_resume_job,put,,R2 Super Slurper,r2_super_slurper,jobs,resume,exec,,Resume a job -r2.yaml,/accounts/{account_id}/slurper/source/connectivity-precheck,slurper-check-source-connectivity,slurper_check_source_connectivity,put,,R2 Super Slurper,r2_super_slurper,source_connectivity_precheck,update_connectivity_precheck,exec,,Check source connectivity -r2.yaml,/accounts/{account_id}/slurper/target/connectivity-precheck,slurper-check-target-connectivity,slurper_check_target_connectivity,put,,R2 Super Slurper,r2_super_slurper,target_connectivity_precheck,update_connectivity_precheck,exec,,Check target connectivity +r2.yaml,/accounts/{account_id}/slurper/source/connectivity-precheck,slurper-check-source-connectivity,slurper_check_source_connectivity,put,,R2 Super Slurper,r2_super_slurper,buckets,update_source_connectivity_precheck,exec,,Check source connectivity +r2.yaml,/accounts/{account_id}/slurper/target/connectivity-precheck,slurper-check-target-connectivity,slurper_check_target_connectivity,put,,R2 Super Slurper,r2_super_slurper,buckets,update_target_connectivity_precheck,exec,,Check target connectivity r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog,list-catalogs,list_catalogs,get,,R2 Catalog Management,r2_catalog_management,r2_catalog,list,select,$.result.warehouses,List R2 catalogs r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name},get-catalog-details,get_catalog_details,get,,R2 Catalog Management,r2_catalog_management,r2_catalog,get,select,$.result,Get R2 catalog details r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/credential,store-credentials,store_credentials,post,,Credential Management,credential_management,r2_catalog,create_credential,exec,,Store catalog credentials r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/disable,disable-catalog,disable_catalog,post,,R2 Catalog Management,r2_catalog_management,r2_catalog,disable,exec,,Disable R2 catalog r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/enable,enable-catalog,enable_catalog,post,,R2 Catalog Management,r2_catalog_management,r2_catalog,enable,exec,,Enable R2 bucket as a catalog -r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs,get-maintenance-config,get_maintenance_config,get,,Maintenance Configuration,maintenance_configuration,r2_catalog_maintenance_configs,list_by_account,select,$.result,Get catalog maintenance configuration -r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs,update-maintenance-config,update_maintenance_config,post,,Maintenance Configuration,maintenance_configuration,r2_catalog_maintenance_configs,update_by_account,insert,,Update catalog maintenance configuration +r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs,get-maintenance-config,get_maintenance_config,get,,Maintenance Configuration,maintenance_configuration,maintenance_configs,list,select,$.result,Get catalog maintenance configuration +r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs,update-maintenance-config,update_maintenance_config,post,,Maintenance Configuration,maintenance_configuration,maintenance_configs,update,insert,,Update catalog maintenance configuration r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces,list-namespaces,list_namespaces,get,,Namespace Management,namespace_management,namespaces,list,select,$.result,List namespaces in catalog r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables,list-tables,list_tables,get,,Table Management,table_management,tables,list,select,$.result,List tables in namespace r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs,get-table-maintenance-config,get_table_maintenance_config,get,,Table Maintenance Configuration,table_maintenance_configuration,tables_maintenance_configs,list_by_account,select,$.result,Get table maintenance configuration r2_data_catalog.yaml,/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs,update-table-maintenance-config,update_table_maintenance_config,post,,Table Maintenance Configuration,table_maintenance_configuration,tables_maintenance_configs,update_by_account,insert,,Update table maintenance configuration radar.yaml,/radar/agent_readiness/summary/{dimension},radar-get-agent-readiness-summary,radar_get_agent_readiness_summary,get,,Radar Agent Readiness,radar_agent_readiness,agent_readiness,get,select,$.result,Get agent readiness summary -radar.yaml,/radar/ai/bots/summary/user_agent,radar-get-ai-bots-summary-by-user-agent,radar_get_ai_bots_summary_by_user_agent,get,,Radar AI Bots,radar_ai_bots,bots_summary_user_agent,list,select,$.result,Get AI user agents summary -radar.yaml,/radar/ai/bots/summary/{dimension},radar-get-ai-bots-summary,radar_get_ai_bots_summary,get,,Radar AI Bots,radar_ai_bots,bots_summary_dimension_7adba9,get,select,$.result,Get AI bots HTTP requests distribution by dimension +radar.yaml,/radar/ai/bots/summary/user_agent,radar-get-ai-bots-summary-by-user-agent,radar_get_ai_bots_summary_by_user_agent,get,,Radar AI Bots,radar_ai_bots,ai_bots_summary,list_by_user_agent,select,$.result,Get AI user agents summary +radar.yaml,/radar/ai/bots/summary/{dimension},radar-get-ai-bots-summary,radar_get_ai_bots_summary,get,,Radar AI Bots,radar_ai_bots,ai_bots_summary,get,select,$.result,Get AI bots HTTP requests distribution by dimension radar.yaml,/radar/ai/bots/timeseries,radar-get-ai-bots-timeseries,radar_get_ai_bots_timeseries,get,,Radar AI Bots,radar_ai_bots,ai_bots_timeseries,list,select,$.result,Get AI bots HTTP requests time series -radar.yaml,/radar/ai/bots/timeseries_groups/user_agent,radar-get-ai-bots-timeseries-group-by-user-agent,radar_get_ai_bots_timeseries_group_by_user_agent,get,,Radar AI Bots,radar_ai_bots,bots_timeseries_groups_user_agent,list,select,$.result,Get AI user agents time series -radar.yaml,/radar/ai/bots/timeseries_groups/{dimension},radar-get-ai-bots-timeseries-group,radar_get_ai_bots_timeseries_group,get,,Radar AI Bots,radar_ai_bots,bots_timeseries_groups_dimension_5dbf28,get,select,$.result,Get time series distribution of AI bots HTTP requests by dimension. +radar.yaml,/radar/ai/bots/timeseries_groups/user_agent,radar-get-ai-bots-timeseries-group-by-user-agent,radar_get_ai_bots_timeseries_group_by_user_agent,get,,Radar AI Bots,radar_ai_bots,ai_bots_timeseries_groups,list_by_user_agent,select,$.result,Get AI user agents time series +radar.yaml,/radar/ai/bots/timeseries_groups/{dimension},radar-get-ai-bots-timeseries-group,radar_get_ai_bots_timeseries_group,get,,Radar AI Bots,radar_ai_bots,ai_bots_timeseries_groups,get,select,$.result,Get time series distribution of AI bots HTTP requests by dimension. radar.yaml,/radar/ai/inference/summary/model,radar-get-ai-inference-summary-by-model,radar_get_ai_inference_summary_by_model,get,,Radar AI Inference,radar_ai_inference,inference_summary_model,list,select,$.result,Get Workers AI models summary radar.yaml,/radar/ai/inference/summary/task,radar-get-ai-inference-summary-by-task,radar_get_ai_inference_summary_by_task,get,,Radar AI Inference,radar_ai_inference,inference_summary_task,list,select,$.result,Get Workers AI tasks summary radar.yaml,/radar/ai/inference/summary/{dimension},radar-get-ai-inference-summary,radar_get_ai_inference_summary,get,,Radar AI Inference,radar_ai_inference,inference_summary,get,select,$.result,Get Workers AI inference distribution by dimension @@ -1566,12 +1566,12 @@ radar.yaml,/radar/bgp/timeseries,radar-get-bgp-timeseries,radar_get_bgp_timeseri radar.yaml,/radar/bgp/top/ases,radar-get-bgp-top-ases,radar_get_bgp_top_ases,get,,Radar BGP,radar_bgp,bgp_top_ases,list,select,$.result,Get top ASes by BGP updates radar.yaml,/radar/bgp/top/ases/prefixes,radar-get-bgp-top-asns-by-prefixes,radar_get_bgp_top_asns_by_prefixes,get,,Radar BGP,radar_bgp,top_ases_prefixes,list,select,$.result,Get top ASes by prefix count radar.yaml,/radar/bgp/top/prefixes,radar-get-bgp-top-prefixes,radar_get_bgp_top_prefixes,get,,Radar BGP,radar_bgp,bgp_top_prefixes,list,select,$.result,Get top prefixes by BGP updates -radar.yaml,/radar/bots,radar-get-bots,radar_get_bots,get,,Radar Bots,radar_bots,radar_bots,list,select,$.result.bots,List bots +radar.yaml,/radar/bots,radar-get-bots,radar_get_bots,get,,Radar Bots,radar_bots,bots,list,select,$.result.bots,List bots radar.yaml,/radar/bots/crawlers/summary/{dimension},radar-get-crawlers-summary,radar_get_crawlers_summary,get,,Radar Web Crawlers,radar_web_crawlers,crawlers_summary,get,select,$.result,Get crawler HTTP request distribution by dimension radar.yaml,/radar/bots/crawlers/timeseries_groups/{dimension},radar-get-crawlers-timeseries-group,radar_get_crawlers_timeseries_group,get,,Radar Web Crawlers,radar_web_crawlers,crawlers_timeseries_groups,get,select,$.result,Get time series of crawler HTTP request distribution by dimension -radar.yaml,/radar/bots/summary/{dimension},radar-get-bots-summary,radar_get_bots_summary,get,,Radar Bots,radar_bots,bots_summary_dimension_f85b26,get,select,$.result,Get bots HTTP requests distribution by dimension +radar.yaml,/radar/bots/summary/{dimension},radar-get-bots-summary,radar_get_bots_summary,get,,Radar Bots,radar_bots,bots_summary,get,select,$.result,Get bots HTTP requests distribution by dimension radar.yaml,/radar/bots/timeseries,radar-get-bots-timeseries,radar_get_bots_timeseries,get,,Radar Bots,radar_bots,bots_timeseries,list,select,$.result,Get bots HTTP requests time series -radar.yaml,/radar/bots/timeseries_groups/{dimension},radar-get-bots-timeseries-group,radar_get_bots_timeseries_group,get,,Radar Bots,radar_bots,bots_timeseries_groups_dimension_42beed,get,select,$.result,Get time series distribution of bots HTTP requests by dimension. +radar.yaml,/radar/bots/timeseries_groups/{dimension},radar-get-bots-timeseries-group,radar_get_bots_timeseries_group,get,,Radar Bots,radar_bots,bots_timeseries_groups,get,select,$.result,Get time series distribution of bots HTTP requests by dimension. radar.yaml,/radar/bots/{bot_slug},radar-get-bot-details,radar_get_bot_details,get,,Radar Bots,radar_bots,bots,get,select,$.result,Get bot details radar.yaml,/radar/ct/authorities,radar-get-certificate-authorities,radar_get_certificate_authorities,get,,Radar Certificate Transparency,radar_certificate_transparency,authorities,list,select,$.result.certificateAuthorities,List certificate authorities radar.yaml,/radar/ct/authorities/{ca_slug},radar-get-certificate-authority-details,radar_get_certificate_authority_details,get,,Radar Certificate Transparency,radar_certificate_transparency,authorities,get,select,$.result,Get certificate authority details @@ -1809,7 +1809,7 @@ realtime_kit.yaml,/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook realtime_kit.yaml,/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id},getWebhook,getWebhook,get,realtimekitWebhookSuccessResponse,Webhooks,webhooks,webhooks,get,select,,Fetch details of a webhook realtime_kit.yaml,/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id},editWebhook,editWebhook,patch,realtimekitWebhookSuccessResponse,Webhooks,webhooks,webhooks,edit_webhook,update,,Edit a webhook realtime_kit.yaml,/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id},replaceWebhook,replaceWebhook,put,realtimekitWebhookSuccessResponse,Webhooks,webhooks,webhooks,replace_webhook,replace,,Replace a webhook -registrar.yaml,/accounts/{account_id}/registrar/domain-check,registrar-domain-discovery-check,registrar_domain_discovery_check,post,registrarApiDomainCheckResponse,Domain Discovery,domain_discovery,registrar,create_domain_check,exec,,Check domain availability +registrar.yaml,/accounts/{account_id}/registrar/domain-check,registrar-domain-discovery-check,registrar_domain_discovery_check,post,registrarApiDomainCheckResponse,Domain Discovery,domain_discovery,registrar,create_domain_check,select,$.result.domains,Check domain availability registrar.yaml,/accounts/{account_id}/registrar/domain-search,registrar-domain-discovery-search,registrar_domain_discovery_search,get,registrarApiDomainSearchResponse,Domain Discovery,domain_discovery,domain_search,list,select,$.result.domains,Search for available domains registrar.yaml,/accounts/{account_id}/registrar/domains,registrar-domains-list-domains,registrar_domains_list_domains,get,registrarApiDomainResponseCollection,Registrar Domains,registrar_domains,domains,list,select,$.result,List domains registrar.yaml,/accounts/{account_id}/registrar/domains/{domain_name},registrar-domains-get-domain,registrar_domains_get_domain,get,registrarApiDomainResponseSingle,Registrar Domains,registrar_domains,domains,get,select,,Get domain @@ -1868,10 +1868,10 @@ rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id},put_accounts_account_ rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/rules,post_accounts_account_id_rulesets_ruleset_id_rules,post_accounts_account_id_rulesets_ruleset_id_rules,post,,,,rules,create_by_account,insert,,Create an account or zone ruleset rule rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id},delete_accounts_account_id_rulesets_ruleset_id_rules_rule_id,delete_accounts_account_id_rulesets_ruleset_id_rules_rule_id,delete,,,,rules,delete_by_account,delete,,Delete an account or zone ruleset rule rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id},patch_accounts_account_id_rulesets_ruleset_id_rules_rule_id,patch_accounts_account_id_rulesets_ruleset_id_rules_rule_id,patch,,,,rules,edit_by_account,update,,Update an account or zone ruleset rule -rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions,get_accounts_account_id_rulesets_ruleset_id_versions,get_accounts_account_id_rulesets_ruleset_id_versions,get,,,,rulesets_versions,list_by_account,select,$.result,List an account or zone ruleset's versions +rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions,get_accounts_account_id_rulesets_ruleset_id_versions,get_accounts_account_id_rulesets_ruleset_id_versions,get,,,,versions,list_by_account,select,$.result,List an account or zone ruleset's versions rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version},delete_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version,delete_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version,delete,,,,versions,delete_by_account,delete,,Delete an account or zone ruleset version -rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version},get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version,get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version,get,,,,rulesets_versions,get_by_account,select,$.result,Get an account or zone ruleset version -rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag},get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get,,,,by_tag,get_by_account,select,$.result,List an account or zone ruleset version's rules by tag +rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version},get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version,get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version,get,,,,versions,get_by_account,select,$.result,Get an account or zone ruleset version +rulesets.yaml,/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag},get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get,,,,rulesets,list_rules_by_tag_by_account,select,$.result,List an account or zone ruleset version's rules by tag rulesets.yaml,/zones/{zone_id}/rulesets,get_zones_zone_id_rulesets,get_zones_zone_id_rulesets,get,,,,rulesets,list_by_zone,select,$.result,List account or zone rulesets rulesets.yaml,/zones/{zone_id}/rulesets,post_zones_zone_id_rulesets,post_zones_zone_id_rulesets,post,,,,rulesets,create_by_zone,insert,,Create an account or zone ruleset rulesets.yaml,/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint,get_zones_zone_id_rulesets_phases_ruleset_phase_entrypoint,get_zones_zone_id_rulesets_phases_ruleset_phase_entrypoint,get,,,,phases,list_by_zone,select,$.result,Get an account or zone entry point ruleset @@ -1884,10 +1884,10 @@ rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id},put_zones_zone_id_rulesets_ rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/rules,post_zones_zone_id_rulesets_ruleset_id_rules,post_zones_zone_id_rulesets_ruleset_id_rules,post,,,,rules,create_by_zone,insert,,Create an account or zone ruleset rule rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id},delete_zones_zone_id_rulesets_ruleset_id_rules_rule_id,delete_zones_zone_id_rulesets_ruleset_id_rules_rule_id,delete,,,,rules,delete_by_zone,delete,,Delete an account or zone ruleset rule rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id},patch_zones_zone_id_rulesets_ruleset_id_rules_rule_id,patch_zones_zone_id_rulesets_ruleset_id_rules_rule_id,patch,,,,rules,edit_by_zone,update,,Update an account or zone ruleset rule -rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions,get_zones_zone_id_rulesets_ruleset_id_versions,get_zones_zone_id_rulesets_ruleset_id_versions,get,,,,rulesets_versions,list_by_zone,select,$.result,List an account or zone ruleset's versions +rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions,get_zones_zone_id_rulesets_ruleset_id_versions,get_zones_zone_id_rulesets_ruleset_id_versions,get,,,,versions,list_by_zone,select,$.result,List an account or zone ruleset's versions rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version},delete_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version,delete_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version,delete,,,,versions,delete_by_zone,delete,,Delete an account or zone ruleset version -rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version},get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version,get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version,get,,,,rulesets_versions,get_by_zone,select,$.result,Get an account or zone ruleset version -rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag},get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get,,,,by_tag,get_by_zone,select,$.result,List an account or zone ruleset version's rules by tag +rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version},get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version,get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version,get,,,,versions,get_by_zone,select,$.result,Get an account or zone ruleset version +rulesets.yaml,/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag},get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag,get,,,,rulesets,list_rules_by_tag_by_zone,select,$.result,List an account or zone ruleset version's rules by tag rum.yaml,/accounts/{account_id}/rum/site_info,web-analytics-create-site,web_analytics_create_site,post,rumSiteResponseSingle,Web Analytics,web_analytics,site_info,create,insert,,Create a Web Analytics site rum.yaml,/accounts/{account_id}/rum/site_info/list,web-analytics-list-sites,web_analytics_list_sites,get,rumSitesResponseCollection,Web Analytics,web_analytics,site_info,list,select,$.result,List Web Analytics sites rum.yaml,/accounts/{account_id}/rum/site_info/{site_id},web-analytics-delete-site,web_analytics_delete_site,delete,rumSiteTagResponseSingle,Web Analytics,web_analytics,site_info,delete,delete,,Delete a Web Analytics site @@ -1937,29 +1937,29 @@ secrets_store.yaml,/system/accounts/{account_tag}/stores/{store_id}/secrets/{sec secrets_store.yaml,/system/accounts/{account_tag}/stores/{store_id}/secrets/{secret_id},secrets-store-system-patch-by-id,secrets_store_system_patch_by_id,patch,secretsStoreSecretResponse,Secrets Store,secrets_store,secrets,secrets_store_system_patch_by_id,update,,Patch a secret (System) secrets_store.yaml,/system/accounts/{account_tag}/stores/{store_id}/secrets/{secret_id}/duplicate,secrets-store-system-duplicate-by-id,secrets_store_system_duplicate_by_id,post,secretsStoreSecretResponse,Secrets Store,secrets_store,secrets,duplicate_by_system,exec,,Duplicate secret (System) security_center.yaml,/accounts/{account_id}/security-center/insights,get_accounts_account_id_security_center_insights,get_accounts_account_id_security_center_insights,get,,,,insights,list_by_account,select,$.result,Retrieves Security Center Insights -security_center.yaml,/accounts/{account_id}/security-center/insights/audit-log,get_accounts_account_id_security_center_insights_audit_log,get_accounts_account_id_security_center_insights_audit_log,get,securityCenterAuditLogResponse,,,audit_logs_6f0256,list_by_account,select,$.result,Retrieves account or zone Audit Log +security_center.yaml,/accounts/{account_id}/security-center/insights/audit-log,get_accounts_account_id_security_center_insights_audit_log,get_accounts_account_id_security_center_insights_audit_log,get,securityCenterAuditLogResponse,,,audit_logs,list_by_account,select,$.result,Retrieves account or zone Audit Log security_center.yaml,/accounts/{account_id}/security-center/insights/class,get_accounts_account_id_security_center_insights_class,get_accounts_account_id_security_center_insights_class,get,securityCenterValueCountsResponse,,,class,list_by_account,select,$.result,Retrieves Security Center Insight Counts by Class security_center.yaml,/accounts/{account_id}/security-center/insights/scans,get_accounts_account_id_security_center_insights_scans,get_accounts_account_id_security_center_insights_scans,get,,,,scans,list_by_account,select,$.result,Get Recent account or zone Scans security_center.yaml,/accounts/{account_id}/security-center/insights/scans,post_accounts_account_id_security_center_insights_scans,post_accounts_account_id_security_center_insights_scans,post,,,,scans,post_accounts_account_id_security_center_insights_scans,insert,,Start On-Demand account or zone Scan security_center.yaml,/accounts/{account_id}/security-center/insights/severity,get_accounts_account_id_security_center_insights_severity,get_accounts_account_id_security_center_insights_severity,get,securityCenterValueCountsResponse,,,severity,list_by_account,select,$.result,Retrieves Security Center Insight Counts by Severity security_center.yaml,/accounts/{account_id}/security-center/insights/type,get_accounts_account_id_security_center_insights_type,get_accounts_account_id_security_center_insights_type,get,securityCenterValueCountsResponse,,,type,list_by_account,select,$.result,Retrieves Security Center Insight Counts by Type -security_center.yaml,/accounts/{account_id}/security-center/insights/{issue_id}/audit-log,get_accounts_account_id_security_center_insights_issue_id_audit_log,get_accounts_account_id_security_center_insights_issue_id_audit_log,get,securityCenterAuditLogResponse,,,audit_logs_8c2f64,list_by_account,select,$.result,Retrieves Issue Audit Log +security_center.yaml,/accounts/{account_id}/security-center/insights/{issue_id}/audit-log,get_accounts_account_id_security_center_insights_issue_id_audit_log,get_accounts_account_id_security_center_insights_issue_id_audit_log,get,securityCenterAuditLogResponse,,,audit_logs,list_by_account_issue,select,$.result,Retrieves Issue Audit Log security_center.yaml,/accounts/{account_id}/security-center/insights/{issue_id}/classification,patch_accounts_account_id_security_center_insights_issue_id_classification,patch_accounts_account_id_security_center_insights_issue_id_classification,patch,securityCenterApiResponseSingle,,,classification,update_by_account,update,,Updates Security Center Insight Classification security_center.yaml,/accounts/{account_id}/security-center/insights/{issue_id}/context,get-security-center-insight-context,get_security_center_insight_context,get,,Security Center Insights,security_center_insights,context,list,select,,Retrieves Security Center Insight Context security_center.yaml,/accounts/{account_id}/security-center/insights/{issue_id}/dismiss,put_accounts_account_id_security_center_insights_issue_id_dismiss,put_accounts_account_id_security_center_insights_issue_id_dismiss,put,securityCenterApiResponseSingle,,,insights,dismiss_by_account,replace,,Archives Security Center Insight security_center.yaml,/zones/{zone_id}/security-center/insights,get_zones_zone_id_security_center_insights,get_zones_zone_id_security_center_insights,get,,,,insights,list_by_zone,select,$.result,Retrieves Security Center Insights -security_center.yaml,/zones/{zone_id}/security-center/insights/audit-log,get_zones_zone_id_security_center_insights_audit_log,get_zones_zone_id_security_center_insights_audit_log,get,securityCenterAuditLogResponse,,,audit_logs_bff19a,list_by_zone,select,$.result,Retrieves account or zone Audit Log +security_center.yaml,/zones/{zone_id}/security-center/insights/audit-log,get_zones_zone_id_security_center_insights_audit_log,get_zones_zone_id_security_center_insights_audit_log,get,securityCenterAuditLogResponse,,,audit_logs,list_by_zone,select,$.result,Retrieves account or zone Audit Log security_center.yaml,/zones/{zone_id}/security-center/insights/class,get_zones_zone_id_security_center_insights_class,get_zones_zone_id_security_center_insights_class,get,securityCenterValueCountsResponse,,,class,list_by_zone,select,$.result,Retrieves Security Center Insight Counts by Class security_center.yaml,/zones/{zone_id}/security-center/insights/scans,get_zones_zone_id_security_center_insights_scans,get_zones_zone_id_security_center_insights_scans,get,,,,scans,list_by_zone,select,$.result,Get Recent account or zone Scans security_center.yaml,/zones/{zone_id}/security-center/insights/scans,post_zones_zone_id_security_center_insights_scans,post_zones_zone_id_security_center_insights_scans,post,,,,scans,post_zones_zone_id_security_center_insights_scans,insert,,Start On-Demand account or zone Scan security_center.yaml,/zones/{zone_id}/security-center/insights/severity,get_zones_zone_id_security_center_insights_severity,get_zones_zone_id_security_center_insights_severity,get,securityCenterValueCountsResponse,,,severity,list_by_zone,select,$.result,Retrieves Security Center Insight Counts by Severity security_center.yaml,/zones/{zone_id}/security-center/insights/type,get_zones_zone_id_security_center_insights_type,get_zones_zone_id_security_center_insights_type,get,securityCenterValueCountsResponse,,,type,list_by_zone,select,$.result,Retrieves Security Center Insight Counts by Type -security_center.yaml,/zones/{zone_id}/security-center/insights/{issue_id}/audit-log,get_zones_zone_id_security_center_insights_issue_id_audit_log,get_zones_zone_id_security_center_insights_issue_id_audit_log,get,securityCenterAuditLogResponse,,,audit_logs_e60d54,list_by_zone,select,$.result,Retrieves Issue Audit Log +security_center.yaml,/zones/{zone_id}/security-center/insights/{issue_id}/audit-log,get_zones_zone_id_security_center_insights_issue_id_audit_log,get_zones_zone_id_security_center_insights_issue_id_audit_log,get,securityCenterAuditLogResponse,,,audit_logs,list_by_zone_issue,select,$.result,Retrieves Issue Audit Log security_center.yaml,/zones/{zone_id}/security-center/insights/{issue_id}/classification,patch_zones_zone_id_security_center_insights_issue_id_classification,patch_zones_zone_id_security_center_insights_issue_id_classification,patch,securityCenterApiResponseSingle,,,classification,update_by_zone,update,,Updates Security Center Insight Classification security_center.yaml,/zones/{zone_id}/security-center/insights/{issue_id}/dismiss,put_zones_zone_id_security_center_insights_issue_id_dismiss,put_zones_zone_id_security_center_insights_issue_id_dismiss,put,securityCenterApiResponseSingle,,,insights,dismiss_by_zone,replace,,Archives Security Center Insight -security_txt.yaml,/zones/{zone_id}/security-center/securitytxt,delete-security-txt,delete_security_txt,delete,securityCenterApiResponseSingle,security.txt,security_txt,securitytxt,delete,delete,,Deletes security.txt -security_txt.yaml,/zones/{zone_id}/security-center/securitytxt,get-security-txt,get_security_txt,get,,security.txt,security_txt,securitytxt,list,select,$.result,Retrieves security.txt -security_txt.yaml,/zones/{zone_id}/security-center/securitytxt,update-security-txt,update_security_txt,put,securityCenterApiResponseSingle,security.txt,security_txt,securitytxt,update,replace,,Updates security.txt +security_txt.yaml,/zones/{zone_id}/security-center/securitytxt,delete-security-txt,delete_security_txt,delete,securityCenterApiResponseSingle,security.txt,security_txt,security_txt,delete,delete,,Deletes security.txt +security_txt.yaml,/zones/{zone_id}/security-center/securitytxt,get-security-txt,get_security_txt,get,,security.txt,security_txt,security_txt,list,select,$.result,Retrieves security.txt +security_txt.yaml,/zones/{zone_id}/security-center/securitytxt,update-security-txt,update_security_txt,put,securityCenterApiResponseSingle,security.txt,security_txt,security_txt,update,replace,,Updates security.txt snippets.yaml,/zones/{zone_id}/snippets,listZoneSnippets,listZoneSnippets,get,,Zone Snippets,zone_snippets,snippets,list,select,$.result,List zone snippets snippets.yaml,/zones/{zone_id}/snippets/snippet_rules,deleteZoneSnippetRules,deleteZoneSnippetRules,delete,,Zone Snippets,zone_snippets,rules,delete,delete,,Delete zone snippet rules snippets.yaml,/zones/{zone_id}/snippets/snippet_rules,listZoneSnippetRules,listZoneSnippetRules,get,,Zone Snippets,zone_snippets,rules,list,select,$.result,List zone snippet rules @@ -1977,7 +1977,7 @@ spectrum.yaml,/zones/{zone_id}/spectrum/apps/{app_id},spectrum-applications-dele spectrum.yaml,/zones/{zone_id}/spectrum/apps/{app_id},spectrum-applications-get-spectrum-application-configuration,spectrum_applications_get_spectrum_application_configuration,get,spectrumConfigAppConfigSingle,Spectrum Applications,spectrum_applications,apps,get,select,$.result,Get Spectrum application configuration spectrum.yaml,/zones/{zone_id}/spectrum/apps/{app_id},spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin,spectrum_applications_update_spectrum_application_configuration_using_a_name_for_the_origin,put,spectrumConfigAppConfigSingle,Spectrum Applications,spectrum_applications,apps,update,replace,,Update Spectrum application configuration using a name for the origin speed.yaml,/zones/{zone_id}/speed_api/availabilities,speed-get-availabilities,speed_get_availabilities,get,observatoryAvailabilitiesResponse,Observatory,observatory,availabilities,list,select,$.result,Get quota and availability -speed.yaml,/zones/{zone_id}/speed_api/pages,speed-list-pages,speed_list_pages,get,observatoryPagesResponseCollection,Observatory,observatory,speed_api_pages,list_by_zone,select,$.result,List tested webpages +speed.yaml,/zones/{zone_id}/speed_api/pages,speed-list-pages,speed_list_pages,get,observatoryPagesResponseCollection,Observatory,observatory,api_pages,list_by_zone,select,$.result,List tested webpages speed.yaml,/zones/{zone_id}/speed_api/pages/{url}/tests,speed-delete-tests,speed_delete_tests,delete,observatoryCountResponse,Observatory,observatory,tests,delete,delete,,Delete all page tests speed.yaml,/zones/{zone_id}/speed_api/pages/{url}/tests,speed-list-test-history,speed_list_test_history,get,observatoryPageTestResponseCollection,Observatory,observatory,tests,list,select,$.result,List page test history speed.yaml,/zones/{zone_id}/speed_api/pages/{url}/tests,speed-create-test,speed_create_test,post,observatoryPageTestResponseSingle,Observatory,observatory,tests,create,insert,,Start page test @@ -1986,7 +1986,7 @@ speed.yaml,/zones/{zone_id}/speed_api/pages/{url}/trend,speed-list-page-trend,sp speed.yaml,/zones/{zone_id}/speed_api/schedule/{url},speed-delete-test-schedule,speed_delete_test_schedule,delete,observatoryCountResponse,Observatory,observatory,schedule,delete,delete,,Delete scheduled page test speed.yaml,/zones/{zone_id}/speed_api/schedule/{url},speed-get-scheduled-test,speed_get_scheduled_test,get,observatoryScheduleResponseSingle,Observatory,observatory,schedule,get,select,$.result,Get a page test schedule speed.yaml,/zones/{zone_id}/speed_api/schedule/{url},speed-create-scheduled-test,speed_create_scheduled_test,post,observatoryCreateScheduleResponse,Observatory,observatory,schedule,create,insert,,Create scheduled page test -ssl.yaml,/zones/{zone_id}/ssl/analyze,analyze-certificate-analyze-certificate,analyze_certificate_analyze_certificate,post,tlsCertificatesAndHostnamesCertificateAnalyzeResponse,Analyze Certificate,analyze_certificate,ssl,create_analyze,exec,,Analyze Certificate +ssl.yaml,/zones/{zone_id}/ssl/analyze,analyze-certificate-analyze-certificate,analyze_certificate_analyze_certificate,post,tlsCertificatesAndHostnamesCertificateAnalyzeResponse,Analyze Certificate,analyze_certificate,ssl,create_analyze,select,,Analyze Certificate ssl.yaml,/zones/{zone_id}/ssl/certificate_packs,certificate-packs-list-certificate-packs,certificate_packs_list_certificate_packs,get,tlsCertificatesAndHostnamesCertificatePackResponseCollection,Certificate Packs,certificate_packs,certificate_packs,list,select,$.result,List Certificate Packs ssl.yaml,/zones/{zone_id}/ssl/certificate_packs/order,certificate-packs-order-advanced-certificate-manager-certificate-pack,certificate_packs_order_advanced_certificate_manager_certificate_pack,post,tlsCertificatesAndHostnamesAdvancedCertificatePackResponseSingle,Certificate Packs,certificate_packs,certificate_packs,create,insert,,Order Advanced Certificate Manager Certificate Pack ssl.yaml,/zones/{zone_id}/ssl/certificate_packs/quota,certificate-packs-get-certificate-pack-quotas,certificate_packs_get_certificate_pack_quotas,get,tlsCertificatesAndHostnamesCertificatePackQuotaResponse,Certificate Packs,certificate_packs,quota,list,select,$.result,Get Certificate Pack Quotas @@ -2058,8 +2058,8 @@ token_validation.yaml,/zones/{zone_id}/token_validation/config/{config_id},token token_validation.yaml,/zones/{zone_id}/token_validation/config/{config_id}/credentials,token-validation-config-credentials-update,token_validation_config_credentials_update,put,,Token Validation Token Configuration,token_validation_token_configuration,token_validation,update_credentials,exec,,Update Token Configuration credentials token_validation.yaml,/zones/{zone_id}/token_validation/rules,token-validation-rules-list,token_validation_rules_list,get,,Token Validation Token Rules,token_validation_token_rules,rules,list,select,$.result,List token validation rules token_validation.yaml,/zones/{zone_id}/token_validation/rules,token-validation-rules-create,token_validation_rules_create,post,,Token Validation Token Rules,token_validation_token_rules,rules,create,insert,,Create a token validation rule -token_validation.yaml,/zones/{zone_id}/token_validation/rules/bulk,token-validation-rules-bulk-edit,token_validation_rules_bulk_edit,patch,,Token Validation Token Rules,token_validation_token_rules,bulk,token_validation_rules_bulk_edit,update,,Bulk edit token validation rules -token_validation.yaml,/zones/{zone_id}/token_validation/rules/bulk,token-validation-rules-bulk-create,token_validation_rules_bulk_create,post,,Token Validation Token Rules,token_validation_token_rules,bulk,token_validation_rules_bulk_create,insert,,Bulk create token validation rules +token_validation.yaml,/zones/{zone_id}/token_validation/rules/bulk,token-validation-rules-bulk-edit,token_validation_rules_bulk_edit,patch,,Token Validation Token Rules,token_validation_token_rules,rules,bulk_edit,exec,,Bulk edit token validation rules +token_validation.yaml,/zones/{zone_id}/token_validation/rules/bulk,token-validation-rules-bulk-create,token_validation_rules_bulk_create,post,,Token Validation Token Rules,token_validation_token_rules,rules,bulk_create,exec,,Bulk create token validation rules token_validation.yaml,/zones/{zone_id}/token_validation/rules/preview,token-validation-rules-preview,token_validation_rules_preview,post,,Token Validation Token Rules,token_validation_token_rules,rules,preview,exec,,Preview operations covered by a Token Validation rule token_validation.yaml,/zones/{zone_id}/token_validation/rules/{rule_id},token-validation-rules-delete,token_validation_rules_delete,delete,apiShieldApiResponseSingleObj,Token Validation Token Rules,token_validation_token_rules,rules,delete,delete,,Delete a zone token validation rule token_validation.yaml,/zones/{zone_id}/token_validation/rules/{rule_id},token-validation-rules-get,token_validation_rules_get,get,,Token Validation Token Rules,token_validation_token_rules,rules,get,select,$.result,Get a zone token validation rule @@ -2115,7 +2115,7 @@ vectorize.yaml,/accounts/{account_id}/vectorize/indexes,vectorize-(-deprecated)- vectorize.yaml,/accounts/{account_id}/vectorize/indexes,vectorize-(-deprecated)-create-vectorize-index,vectorize_(_deprecated)_create_vectorize_index,post,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,vectorize_indexes,vectorize_deprecated_create_vectorize_index,insert,,Create Vectorize Index (Deprecated) vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name},vectorize-(-deprecated)-delete-vectorize-index,vectorize_(_deprecated)_delete_vectorize_index,delete,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,vectorize_indexes,vectorize_deprecated_delete_vectorize_index,delete,,Delete Vectorize Index (Deprecated) vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name},vectorize-(-deprecated)-get-vectorize-index,vectorize_(_deprecated)_get_vectorize_index,get,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,vectorize_indexes,get,select,$.result,Get Vectorize Index (Deprecated) -vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name},vectorize-(-deprecated)-update-vectorize-index,vectorize_(_deprecated)_update_vectorize_index,put,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,vectorize,update_indexes,exec,,Update Vectorize Index (Deprecated) +vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name},vectorize-(-deprecated)-update-vectorize-index,vectorize_(_deprecated)_update_vectorize_index,put,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,indexes,update_index,exec,,Update Vectorize Index (Deprecated) vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids,vectorize-(-deprecated)-delete-vectors-by-id,vectorize_(_deprecated)_delete_vectors_by_id,post,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,indexes,create_delete_by_ids,exec,,Delete Vectors By Identifier (Deprecated) vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids,vectorize-(-deprecated)-get-vectors-by-id,vectorize_(_deprecated)_get_vectors_by_id,post,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,indexes,get_by_ids,exec,,Get Vectors By Identifier (Deprecated) vectorize.yaml,/accounts/{account_id}/vectorize/indexes/{index_name}/insert,vectorize-(-deprecated)-insert-vector,vectorize_(_deprecated)_insert_vector,post,,Vectorize Beta (Deprecated),vectorize_beta_deprecated,indexes,create_insert,exec,,Insert Vectors (Deprecated) @@ -2133,7 +2133,7 @@ vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/list,vec vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create,vectorize-create-metadata-index,vectorize_create_metadata_index,post,,Vectorize,vectorize,metadata_index,create_v2,exec,,Create Metadata Index vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete,vectorize-delete-metadata-index,vectorize_delete_metadata_index,post,,Vectorize,vectorize,metadata_index,create_delete_v2,exec,,Delete Metadata Index vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list,vectorize-list-metadata-indexes,vectorize_list_metadata_indexes,get,,Vectorize,vectorize,metadata_index,list,select,$.result.metadataIndexes,List Metadata Indexes -vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query,vectorize-query-vector,vectorize_query_vector,post,,Vectorize,vectorize,indexes,query_v2,exec,,Query Vectors +vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query,vectorize-query-vector,vectorize_query_vector,post,,Vectorize,vectorize,indexes,query_v2,select,$.result.matches,Query Vectors vectorize.yaml,/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert,vectorize-upsert-vector,vectorize_upsert_vector,post,,Vectorize,vectorize,indexes,upsert_v2,exec,,Upsert Vectors vulnerability_scanner.yaml,/accounts/{account_id}/vuln_scanner/credential_sets,list-credential-sets,list_credential_sets,get,,Credential Sets,credential_sets,credential_sets,list,select,$.result,List Credential Sets vulnerability_scanner.yaml,/accounts/{account_id}/vuln_scanner/credential_sets,create-credential-set,create_credential_set,post,,Credential Sets,credential_sets,credential_sets,create,insert,,Create Credential Set @@ -2193,7 +2193,7 @@ web3.yaml,/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/conte web3.yaml,/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier},web3-hostname-ipfs-universal-path-gateway-content-list-entry-details,web3_hostname_ipfs_universal_path_gateway_content_list_entry_details,get,web3ContentListEntrySingleResponse,Web3 Hostname,web3_hostname,entries,get,select,$.result,IPFS Universal Path Gateway Content List Entry Details web3.yaml,/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier},web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry,web3_hostname_edit_ipfs_universal_path_gateway_content_list_entry,put,web3ContentListEntrySingleResponse,Web3 Hostname,web3_hostname,entries,update,replace,,Edit IPFS Universal Path Gateway Content List Entry workers.yaml,/accounts/{account_id}/builds/account/limits,getAccountLimits,getAccountLimits,get,,Account,account,limits,list,select,$.result,Get account limits -workers.yaml,/accounts/{account_id}/builds/builds,getBuildsByVersionIds,getBuildsByVersionIds,get,,Builds,builds,builds_builds,list_by_account,select,$.result,Get builds by version IDs +workers.yaml,/accounts/{account_id}/builds/builds,getBuildsByVersionIds,getBuildsByVersionIds,get,,Builds,builds,builds,list,select,$.result,Get builds by version IDs workers.yaml,/accounts/{account_id}/builds/builds/latest,getLatestBuildsByScripts,getLatestBuildsByScripts,get,,Builds,builds,latest,list,select,$.result,Get latest builds by script IDs workers.yaml,/accounts/{account_id}/builds/builds/{build_uuid},getBuildByUuid,getBuildByUuid,get,,Builds,builds,builds,get,select,$.result,Get build by UUID workers.yaml,/accounts/{account_id}/builds/builds/{build_uuid}/cancel,cancelBuildByUuid,cancelBuildByUuid,put,,Builds,builds,builds,cancel,exec,,Cancel build @@ -2212,7 +2212,7 @@ workers.yaml,/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_v workers.yaml,/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables,upsertEnvironmentVariables,upsertEnvironmentVariables,patch,,Environment Variables,environment_variables,environment_variables,upsert_environment_variables,update,,Upsert environment variables workers.yaml,/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables/{environment_variable_key},deleteEnvironmentVariable,deleteEnvironmentVariable,delete,buildsAPIResponse,Environment Variables,environment_variables,environment_variables,delete_environment_variable,delete,,Delete environment variable workers.yaml,/accounts/{account_id}/builds/triggers/{trigger_uuid}/purge_build_cache,purgeBuildCache,purgeBuildCache,post,buildsAPIResponse,Triggers,triggers,triggers,purge_build_cache,exec,,Purge build cache -workers.yaml,/accounts/{account_id}/builds/workers/{external_script_id}/builds,listBuildsByScript,listBuildsByScript,get,,Workers,workers,workers_builds,list_by_account,select,$.result,List builds by script +workers.yaml,/accounts/{account_id}/builds/workers/{external_script_id}/builds,listBuildsByScript,listBuildsByScript,get,,Workers,workers,builds,list_by_script,select,$.result,List builds by script workers.yaml,/accounts/{account_id}/builds/workers/{external_script_id}/triggers,listTriggersByScript,listTriggersByScript,get,,Workers,workers,triggers,list,select,$.result,List triggers by script workers.yaml,/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks,listDeployHooks,listDeployHooks,get,,Deploy Hooks,deploy_hooks,deploy_hooks,list,select,$.result,List deploy hooks workers.yaml,/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks,createDeployHook,createDeployHook,post,,Deploy Hooks,deploy_hooks,deploy_hooks,create_deploy_hook,insert,,Create deploy hook @@ -2225,7 +2225,7 @@ workers.yaml,/accounts/{account_id}/workers/account-settings,worker-account-sett workers.yaml,/accounts/{account_id}/workers/account-settings,worker-account-settings-create-worker-account-settings,worker_account_settings_create_worker_account_settings,put,,Worker Account Settings,worker_account_settings,account_settings,update,replace,,Create Worker Account Settings workers.yaml,/accounts/{account_id}/workers/assets/upload,worker-assets-upload,worker_assets_upload,post,workersCompletedUploadAssetsResponse,Worker Script,worker_script,workers,upload,exec,,Upload Assets workers.yaml,/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts,namespace-worker-delete-scripts,namespace_worker_delete_scripts,delete,workersNamespaceScriptDeleteBulkResponse,Workers for Platforms,workers_for_platforms,scripts,namespace_worker_delete_scripts,delete,,Delete Scripts in Namespace -workers.yaml,/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts,namespace-worker-list-scripts,namespace_worker_list_scripts,get,,Workers for Platforms,workers_for_platforms,scripts,list,select,$.result,List Scripts in Namespace +workers.yaml,/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts,namespace-worker-list-scripts,namespace_worker_list_scripts,get,,Workers for Platforms,workers_for_platforms,scripts,list_by_dispatch_namespace,select,$.result,List Scripts in Namespace workers.yaml,/accounts/{account_id}/workers/domains,workers.domains.list,workers.domains.list,get,,Domains,domains,domains,list,select,$.result,List Domains workers.yaml,/accounts/{account_id}/workers/domains,workers.domains.update,workers.domains.update,put,,Domains,domains,domains,update,replace,,Attach Domain workers.yaml,/accounts/{account_id}/workers/domains/{domain_id},workers.domains.delete,workers.domains.delete,delete,workersApiResponseCommon,Domains,domains,domains,delete,delete,,Detach Domain @@ -2243,8 +2243,8 @@ workers.yaml,/accounts/{account_id}/workers/observability/telemetry/keys,telemet workers.yaml,/accounts/{account_id}/workers/observability/telemetry/query,telemetry.query,telemetry.query,post,,Query run,query_run,workers,query,exec,,Run a query workers.yaml,/accounts/{account_id}/workers/observability/telemetry/values,telemetry.values.list,telemetry.values.list,post,,Values,values,workers,create_values,exec,,List values workers.yaml,/accounts/{account_id}/workers/placement/regions,worker-placement-list-regions,worker_placement_list_regions,get,,Worker Placement,worker_placement,regions,list,select,$.result.providers,List Placement Regions -workers.yaml,/accounts/{account_id}/workers/scripts,worker-script-list-workers,worker_script_list_workers,get,workersScriptResponseCollection,Worker Script,worker_script,workers_scripts,list,select,$.result,List Workers -workers.yaml,/accounts/{account_id}/workers/scripts-search,worker-script-search-workers,worker_script_search_workers,get,,Worker Script,worker_script,workers_scripts_search,list,select,$.result,Search Workers +workers.yaml,/accounts/{account_id}/workers/scripts,worker-script-list-workers,worker_script_list_workers,get,workersScriptResponseCollection,Worker Script,worker_script,scripts,list,select,$.result,List Workers +workers.yaml,/accounts/{account_id}/workers/scripts-search,worker-script-search-workers,worker_script_search_workers,get,,Worker Script,worker_script,scripts,search,exec,$.result,Search Workers workers.yaml,/accounts/{account_id}/workers/scripts/{script_name},worker-script-delete-worker,worker_script_delete_worker,delete,workersApiResponseNullResult,Worker Script,worker_script,scripts,delete,delete,,Delete Worker workers.yaml,/accounts/{account_id}/workers/scripts/{script_name},worker-script-download-worker,worker_script_download_worker,get,,Worker Script,worker_script,scripts,get,select,,Download Worker workers.yaml,/accounts/{account_id}/workers/scripts/{script_name},worker-script-upload-worker-module,worker_script_upload_worker_module,put,workersScriptResponseUploadSingle,Worker Script,worker_script,scripts,update,replace,,Upload Worker Module @@ -2257,7 +2257,7 @@ workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/deployments/{d workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id},worker-deployments-get-deployment,worker_deployments_get_deployment,get,,Worker Deployments,worker_deployments,deployments,get,select,$.result,Get Deployment workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/schedules,worker-cron-trigger-get-cron-triggers,worker_cron_trigger_get_cron_triggers,get,,Worker Cron Trigger,worker_cron_trigger,schedules,list,select,$.result.schedules,Get Cron Triggers workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/schedules,worker-cron-trigger-update-cron-triggers,worker_cron_trigger_update_cron_triggers,put,,Worker Cron Trigger,worker_cron_trigger,schedules,update,replace,,Update Cron Triggers -workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/script-settings,worker-script-settings-get-settings,worker_script_settings_get_settings,get,workersScriptSettingsResponse,Worker Script,worker_script,scripts_script_settings,list_by_account,select,$.result,Get Script Settings +workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/script-settings,worker-script-settings-get-settings,worker_script_settings_get_settings,get,workersScriptSettingsResponse,Worker Script,worker_script,scripts_settings,get,select,$.result,Get Script Settings workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/script-settings,worker-script-settings-patch-settings,worker_script_settings_patch_settings,patch,workersScriptSettingsResponse,Worker Script,worker_script,settings,edit,update,,Patch Script Settings workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/secrets,worker-list-script-secrets,worker_list_script_secrets,get,,Worker Script,worker_script,secrets,list,select,$.result,List script secrets workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/secrets,worker-put-script-secret,worker_put_script_secret,put,,Worker Script,worker_script,secrets,update,replace,,Add script secret @@ -2265,9 +2265,9 @@ workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secre workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name},worker-get-script-secret,worker_get_script_secret,get,,Worker Script,worker_script,secrets,get,select,$.result,Get secret binding workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/settings,worker-script-get-settings,worker_script_get_settings,get,workersScriptAndVersionSettingsResponse,Worker Script,worker_script,script_and_version_settings,list,select,$.result,Get Settings workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/settings,worker-script-patch-settings,worker_script_patch_settings,patch,workersScriptAndVersionSettingsResponse,Worker Script,worker_script,script_and_version_settings,edit,update,,Patch Settings -workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/subdomain,worker-script-delete-subdomain,worker_script_delete_subdomain,delete,,Worker Script,worker_script,subdomain,delete,delete,,Delete Worker subdomain -workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/subdomain,worker-script-get-subdomain,worker_script_get_subdomain,get,,Worker Script,worker_script,subdomain,list,select,$.result,Get Worker subdomain -workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/subdomain,worker-script-post-subdomain,worker_script_post_subdomain,post,,Worker Script,worker_script,subdomain,create,insert,,Post Worker subdomain +workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/subdomain,worker-script-delete-subdomain,worker_script_delete_subdomain,delete,,Worker Script,worker_script,subdomains,delete_script_subdomain,delete,,Delete Worker subdomain +workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/subdomain,worker-script-get-subdomain,worker_script_get_subdomain,get,,Worker Script,worker_script,subdomains,get_script_subdomain,select,$.result,Get Worker subdomain +workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/subdomain,worker-script-post-subdomain,worker_script_post_subdomain,post,,Worker Script,worker_script,subdomains,create_script_subdomain,insert,,Post Worker subdomain workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/tails,get_accounts_account_id_workers_scripts_script_name_tails,get_accounts_account_id_workers_scripts_script_name_tails,get,,Worker Tail Logs,worker_tail_logs,tail,list,select,$.result,List Tails workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/tails,worker-tail-logs-start-tail,worker_tail_logs_start_tail,post,,Worker Tail Logs,worker_tail_logs,tail,create,insert,,Start Tail workers.yaml,/accounts/{account_id}/workers/scripts/{script_name}/tails/{id},worker-tail-logs-delete-tail,worker_tail_logs_delete_tail,delete,workersApiResponseCommon,Worker Tail Logs,worker_tail_logs,tail,delete,delete,,Delete Tail @@ -2289,10 +2289,10 @@ workers.yaml,/accounts/{account_id}/workers/workers/{worker_id},deleteWorker,del workers.yaml,/accounts/{account_id}/workers/workers/{worker_id},getWorker,getWorker,get,,Workers,workers,workers,get,select,$.result,Get Worker workers.yaml,/accounts/{account_id}/workers/workers/{worker_id},editWorker,editWorker,patch,,Workers,workers,workers,edit,update,,Edit Worker workers.yaml,/accounts/{account_id}/workers/workers/{worker_id},updateWorker,updateWorker,put,,Workers,workers,workers,update,replace,,Update Worker -workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions,listWorkerVersions,listWorkerVersions,get,,Versions,versions,workers_versions,list_by_account,select,$.result,List Versions -workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions,createWorkerVersion,createWorkerVersion,post,,Versions,versions,workers_versions,create_by_account,insert,,Create Version +workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions,listWorkerVersions,listWorkerVersions,get,,Versions,versions,versions,list,select,$.result,List Versions +workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions,createWorkerVersion,createWorkerVersion,post,,Versions,versions,versions,create,insert,,Create Version workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id},deleteWorkerVersion,deleteWorkerVersion,delete,workersApiResponseCommon,Versions,versions,workers,delete_versions,exec,,Delete Version -workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id},getWorkerVersion,getWorkerVersion,get,,Versions,versions,workers_versions,get_by_account,select,$.result,Get Version +workers.yaml,/accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id},getWorkerVersion,getWorkerVersion,get,,Versions,versions,versions,get,select,$.result,Get Version workers.yaml,/workers/builds/deploy_hooks/{deploy_hook_uuid},triggerDeployHook,triggerDeployHook,post,,Deploy Hooks,deploy_hooks,deploy_hooks,trigger_deploy_hook,insert,,Trigger deploy hook workers.yaml,/zones/{zone_id}/workers/routes,worker-routes-list-routes,worker_routes_list_routes,get,,Worker Routes,worker_routes,routes,list,select,$.result,List Routes workers.yaml,/zones/{zone_id}/workers/routes,worker-routes-create-route,worker_routes_create_route,post,,Worker Routes,worker_routes,routes,create,insert,,Create Route @@ -2327,7 +2327,7 @@ workflows.yaml,/accounts/{account_id}/workflows/{workflow_name},wor-delete-workf workflows.yaml,/accounts/{account_id}/workflows/{workflow_name},wor-get-workflow-details,wor_get_workflow_details,get,,Workflows,workflows,workflows,get,select,$.result,Get Workflow details workflows.yaml,/accounts/{account_id}/workflows/{workflow_name},wor-create-or-modify-workflow,wor_create_or_modify_workflow,put,,Workflows,workflows,workflows,update,replace,,Create/modify Workflow workflows.yaml,/accounts/{account_id}/workflows/{workflow_name}/instances,wor-list-workflow-instances,wor_list_workflow_instances,get,,Workflows,workflows,instances,list,select,$.result,List of workflow instances -workflows.yaml,/accounts/{account_id}/workflows/{workflow_name}/instances,wor-create-new-workflow-instance,wor_create_new_workflow_instance,post,,Workflows,workflows,workflows_instances,create_by_account,insert,,Create a new workflow instance +workflows.yaml,/accounts/{account_id}/workflows/{workflow_name}/instances,wor-create-new-workflow-instance,wor_create_new_workflow_instance,post,,Workflows,workflows,instances,create,insert,,Create a new workflow instance workflows.yaml,/accounts/{account_id}/workflows/{workflow_name}/instances/batch,wor-batch-create-workflow-instance,wor_batch_create_workflow_instance,post,,Workflows,workflows,instances,batch,exec,,Batch create new Workflow instances workflows.yaml,/accounts/{account_id}/workflows/{workflow_name}/instances/batch/terminate,wor-batch-terminate-workflow-instances,wor_batch_terminate_workflow_instances,post,,Workflows,workflows,terminate,wor_batch_terminate_workflow_instances,insert,,Batch terminate instances of a workflow workflows.yaml,/accounts/{account_id}/workflows/{workflow_name}/instances/terminate,wor-status-terminate-workflow-instances,wor_status_terminate_workflow_instances,get,,Workflows,workflows,terminate,list,select,$.result,Get status of the job responsible for terminate all instances of a workflow @@ -2361,12 +2361,12 @@ zero_trust.yaml,/accounts/{account_id}/access/ai-controls/mcp/servers/{id},mcp-p zero_trust.yaml,/accounts/{account_id}/access/ai-controls/mcp/servers/{id}/sync,mcp-portals-api-sync-server,mcp_portals_api_sync_server,post,,MCP Portal Servers,mcp_portal_servers,servers,sync,insert,,Sync MCP Server Capabilities zero_trust.yaml,/accounts/{account_id}/access/apps,get_accounts_account_id_access_apps,get_accounts_account_id_access_apps,get,accessAppsComponentsSchemasResponseCollection,,,access_apps,list,select,$.result,List Access applications zero_trust.yaml,/accounts/{account_id}/access/apps,post_accounts_account_id_access_apps,post_accounts_account_id_access_apps,post,,,,applications,create_by_account,insert,,Add an Access application -zero_trust.yaml,/accounts/{account_id}/access/apps/ca,get_accounts_account_id_access_apps_ca,get_accounts_account_id_access_apps_ca,get,accessCaComponentsSchemasResponseCollection,,,cas_f84f2f,list_by_account,select,$.result,List short-lived certificate CAs +zero_trust.yaml,/accounts/{account_id}/access/apps/ca,get_accounts_account_id_access_apps_ca,get_accounts_account_id_access_apps_ca,get,accessCaComponentsSchemasResponseCollection,,,cas,list_by_account,select,$.result,List short-lived certificate CAs zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id},delete_accounts_account_id_access_apps_app_id,delete_accounts_account_id_access_apps_app_id,delete,accessIdResponse,,,applications,delete_by_account,delete,,Delete an Access application zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id},get_accounts_account_id_access_apps_app_id,get_accounts_account_id_access_apps_app_id,get,accessAppsComponentsSchemasSingleResponse,,,access_apps,get_by_account,select,$.result,Get an Access application zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id},put_accounts_account_id_access_apps_app_id,put_accounts_account_id_access_apps_app_id,put,,,,applications,update_by_account,replace,,Update an Access application zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id}/ca,delete_accounts_account_id_access_apps_app_id_ca,delete_accounts_account_id_access_apps_app_id_ca,delete,accessSchemasIdResponse,,,cas,delete_by_account,delete,,Delete a short-lived certificate CA -zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id}/ca,get_accounts_account_id_access_apps_app_id_ca,get_accounts_account_id_access_apps_app_id_ca,get,accessCaComponentsSchemasSingleResponse,,,cas_e335ab,list_by_account,select,$.result,Get a short-lived certificate CA +zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id}/ca,get_accounts_account_id_access_apps_app_id_ca,get_accounts_account_id_access_apps_app_id_ca,get,accessCaComponentsSchemasSingleResponse,,,cas,get_by_account,select,$.result,Get a short-lived certificate CA zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id}/ca,post_accounts_account_id_access_apps_app_id_ca,post_accounts_account_id_access_apps_app_id_ca,post,accessCaComponentsSchemasSingleResponse,,,cas,create_by_account,insert,,Create a short-lived certificate CA zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id}/policies,get_accounts_account_id_access_apps_app_id_policies,get_accounts_account_id_access_apps_app_id_policies,get,accessAppPoliciesComponentsSchemasResponseCollection,,,apps_policies,list_by_account,select,$.result,List Access application policies zero_trust.yaml,/accounts/{account_id}/access/apps/{app_id}/policies,post_accounts_account_id_access_apps_app_id_policies,post_accounts_account_id_access_apps_app_id_policies,post,accessAppPoliciesComponentsSchemasSingleResponse,,,apps_policies,create_by_account,insert,,Create an Access application policy @@ -2486,26 +2486,26 @@ zero_trust.yaml,/accounts/{account_id}/devices/networks/{network_id},device-mana zero_trust.yaml,/accounts/{account_id}/devices/physical-devices,list-devices,list_devices,get,,Physical Devices,physical_devices,devices_physical_devices,list,select,$.result,List devices zero_trust.yaml,/accounts/{account_id}/devices/physical-devices/{device_id},delete-device,delete_device,delete,,Physical Devices,physical_devices,devices,delete,delete,,Delete device zero_trust.yaml,/accounts/{account_id}/devices/physical-devices/{device_id},get-device,get_device,get,,Physical Devices,physical_devices,devices_physical_devices,get,select,$.result,Get device -zero_trust.yaml,/accounts/{account_id}/devices/physical-devices/{device_id}/revoke,revoke-device,revoke_device,post,,Physical Devices,physical_devices,physical_devices_revoke,revoke_by_account,exec,,Revoke device registrations +zero_trust.yaml,/accounts/{account_id}/devices/physical-devices/{device_id}/revoke,revoke-device,revoke_device,post,,Physical Devices,physical_devices,devices,revoke_physical_device,exec,,Revoke device registrations zero_trust.yaml,/accounts/{account_id}/devices/policies,devices-list-device-settings-policies,devices_list_device_settings_policies,get,teamsDevicesDeviceSettingsResponseCollection,Devices,devices,devices_policies,list,select,$.result,List device settings profiles zero_trust.yaml,/accounts/{account_id}/devices/policy,devices-get-default-device-settings-policy,devices_get_default_device_settings_policy,get,teamsDevicesDefaultDeviceSettingsResponse,Devices,devices,default,list,select,$.result,Get the default device settings profile zero_trust.yaml,/accounts/{account_id}/devices/policy,devices-update-default-device-settings-policy,devices_update_default_device_settings_policy,patch,teamsDevicesDefaultDeviceSettingsResponse,Devices,devices,default,edit,update,,Update the default device settings profile zero_trust.yaml,/accounts/{account_id}/devices/policy,devices-create-device-settings-policy,devices_create_device_settings_policy,post,teamsDevicesDeviceSettingsResponse,Devices,devices,devices_policy,create,insert,,Create a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/exclude,devices-get-split-tunnel-exclude-list,devices_get_split_tunnel_exclude_list,get,teamsDevicesSplitTunnelResponseCollection,Devices,devices,excludes_9e6eed,list_by_account,select,$.result,Get the Split Tunnel exclude list -zero_trust.yaml,/accounts/{account_id}/devices/policy/exclude,devices-set-split-tunnel-exclude-list,devices_set_split_tunnel_exclude_list,put,teamsDevicesSplitTunnelResponseCollection,Devices,devices,exclude,devices_set_split_tunnel_exclude_list,replace,,Set the Split Tunnel exclude list -zero_trust.yaml,/accounts/{account_id}/devices/policy/fallback_domains,devices-get-local-domain-fallback-list,devices_get_local_domain_fallback_list,get,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains_f560de,list_by_account,select,$.result,Get your Local Domain Fallback list -zero_trust.yaml,/accounts/{account_id}/devices/policy/fallback_domains,devices-set-local-domain-fallback-list,devices_set_local_domain_fallback_list,put,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains,devices_set_local_domain_fallback_list,replace,,Set your Local Domain Fallback list -zero_trust.yaml,/accounts/{account_id}/devices/policy/include,devices-get-split-tunnel-include-list,devices_get_split_tunnel_include_list,get,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,includes_73882e,list_by_account,select,$.result,Get the Split Tunnel include list -zero_trust.yaml,/accounts/{account_id}/devices/policy/include,devices-set-split-tunnel-include-list,devices_set_split_tunnel_include_list,put,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,include,devices_set_split_tunnel_include_list,replace,,Set the Split Tunnel include list +zero_trust.yaml,/accounts/{account_id}/devices/policy/exclude,devices-get-split-tunnel-exclude-list,devices_get_split_tunnel_exclude_list,get,teamsDevicesSplitTunnelResponseCollection,Devices,devices,excludes,list_by_account,select,$.result,Get the Split Tunnel exclude list +zero_trust.yaml,/accounts/{account_id}/devices/policy/exclude,devices-set-split-tunnel-exclude-list,devices_set_split_tunnel_exclude_list,put,teamsDevicesSplitTunnelResponseCollection,Devices,devices,excludes,set,replace,,Set the Split Tunnel exclude list +zero_trust.yaml,/accounts/{account_id}/devices/policy/fallback_domains,devices-get-local-domain-fallback-list,devices_get_local_domain_fallback_list,get,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains,list_by_account,select,$.result,Get your Local Domain Fallback list +zero_trust.yaml,/accounts/{account_id}/devices/policy/fallback_domains,devices-set-local-domain-fallback-list,devices_set_local_domain_fallback_list,put,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains,set,replace,,Set your Local Domain Fallback list +zero_trust.yaml,/accounts/{account_id}/devices/policy/include,devices-get-split-tunnel-include-list,devices_get_split_tunnel_include_list,get,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,includes,list_by_account,select,$.result,Get the Split Tunnel include list +zero_trust.yaml,/accounts/{account_id}/devices/policy/include,devices-set-split-tunnel-include-list,devices_set_split_tunnel_include_list,put,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,includes,set,replace,,Set the Split Tunnel include list zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id},devices-delete-device-settings-policy,devices_delete_device_settings_policy,delete,teamsDevicesDeviceSettingsResponseCollection,Devices,devices,devices,delete_policy,exec,,Delete a device settings profile zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id},devices-get-device-settings-policy-by-id,devices_get_device_settings_policy_by_id,get,teamsDevicesDeviceSettingsResponse,Devices,devices,devices_policy,get_by_account,select,$.result,Get device settings profile by ID zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id},devices-update-device-settings-policy,devices_update_device_settings_policy,patch,teamsDevicesDeviceSettingsResponse,Devices,devices,devices,update_policy,exec,,Update a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/exclude,devices-get-split-tunnel-exclude-list-for-a-device-settings-policy,devices_get_split_tunnel_exclude_list_for_a_device_settings_policy,get,teamsDevicesSplitTunnelResponseCollection,Devices,devices,excludes_26edfa,list_by_account,select,$.result,Get the Split Tunnel exclude list for a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/exclude,devices-set-split-tunnel-exclude-list-for-a-device-settings-policy,devices_set_split_tunnel_exclude_list_for_a_device_settings_policy,put,teamsDevicesSplitTunnelResponseCollection,Devices,devices,exclude,devices_set_split_tunnel_exclude_list_for_a_device_settings_policy,replace,,Set the Split Tunnel exclude list for a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains,devices-get-local-domain-fallback-list-for-a-device-settings-policy,devices_get_local_domain_fallback_list_for_a_device_settings_policy,get,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains_97f458,list_by_account,select,$.result,Get the Local Domain Fallback list for a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains,devices-set-local-domain-fallback-list-for-a-device-settings-policy,devices_set_local_domain_fallback_list_for_a_device_settings_policy,put,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains,devices_set_local_domain_fallback_list_for_a_device_settings_policy,replace,,Set the Local Domain Fallback list for a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/include,devices-get-split-tunnel-include-list-for-a-device-settings-policy,devices_get_split_tunnel_include_list_for_a_device_settings_policy,get,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,includes_11848d,list_by_account,select,$.result,Get the Split Tunnel include list for a device settings profile -zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/include,devices-set-split-tunnel-include-list-for-a-device-settings-policy,devices_set_split_tunnel_include_list_for_a_device_settings_policy,put,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,include,devices_set_split_tunnel_include_list_for_a_device_settings_policy,replace,,Set the Split Tunnel include list for a device settings profile +zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/exclude,devices-get-split-tunnel-exclude-list-for-a-device-settings-policy,devices_get_split_tunnel_exclude_list_for_a_device_settings_policy,get,teamsDevicesSplitTunnelResponseCollection,Devices,devices,excludes,list_by_policy,select,$.result,Get the Split Tunnel exclude list for a device settings profile +zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/exclude,devices-set-split-tunnel-exclude-list-for-a-device-settings-policy,devices_set_split_tunnel_exclude_list_for_a_device_settings_policy,put,teamsDevicesSplitTunnelResponseCollection,Devices,devices,excludes,set_by_policy,replace,,Set the Split Tunnel exclude list for a device settings profile +zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains,devices-get-local-domain-fallback-list-for-a-device-settings-policy,devices_get_local_domain_fallback_list_for_a_device_settings_policy,get,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains,list_by_policy,select,$.result,Get the Local Domain Fallback list for a device settings profile +zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains,devices-set-local-domain-fallback-list-for-a-device-settings-policy,devices_set_local_domain_fallback_list_for_a_device_settings_policy,put,teamsDevicesFallbackDomainResponseCollection,Devices,devices,fallback_domains,set_by_policy,replace,,Set the Local Domain Fallback list for a device settings profile +zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/include,devices-get-split-tunnel-include-list-for-a-device-settings-policy,devices_get_split_tunnel_include_list_for_a_device_settings_policy,get,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,includes,list_by_policy,select,$.result,Get the Split Tunnel include list for a device settings profile +zero_trust.yaml,/accounts/{account_id}/devices/policy/{policy_id}/include,devices-set-split-tunnel-include-list-for-a-device-settings-policy,devices_set_split_tunnel_include_list_for_a_device_settings_policy,put,teamsDevicesSplitTunnelIncludeResponseCollection,Devices,devices,includes,set_by_policy,replace,,Set the Split Tunnel include list for a device settings profile zero_trust.yaml,/accounts/{account_id}/devices/posture,device-posture-rules-list-device-posture-rules,device_posture_rules_list_device_posture_rules,get,teamsDevicesResponseCollection,Device posture rules,device_posture_rules,posture,list,select,$.result,List device posture rules zero_trust.yaml,/accounts/{account_id}/devices/posture,device-posture-rules-create-device-posture-rule,device_posture_rules_create_device_posture_rule,post,teamsDevicesSingleResponse,Device posture rules,device_posture_rules,posture,create,insert,,Create a device posture rule zero_trust.yaml,/accounts/{account_id}/devices/posture/integration,device-posture-integrations-list-device-posture-integrations,device_posture_integrations_list_device_posture_integrations,get,teamsDevicesSchemasResponseCollection,Device Posture Integrations,device_posture_integrations,posture_integration,list,select,$.result,List your device posture integrations @@ -2525,7 +2525,7 @@ zero_trust.yaml,/accounts/{account_id}/devices/registrations/{registration_id},g zero_trust.yaml,/accounts/{account_id}/devices/registrations/{registration_id}/override_codes,get-registration-override-codes,get_registration_override_codes,get,,warp-teams-device-api_other,warp_teams_device_api_other,registrations_override_codes,list_by_account,select,$.result,Get override codes zero_trust.yaml,/accounts/{account_id}/devices/resilience/disconnect,devices-resilience-retrieve-global-warp-override,devices_resilience_retrieve_global_warp_override,get,teamsDevicesGlobalWarpOverrideResponse,Devices Resilience,devices_resilience,global_warp_override,list,select,$.result,Retrieve Global WARP override state zero_trust.yaml,/accounts/{account_id}/devices/resilience/disconnect,devices-resilience-set-global-warp-override,devices_resilience_set_global_warp_override,post,teamsDevicesGlobalWarpOverrideResponse,Devices Resilience,devices_resilience,global_warp_override,create,insert,,Set Global WARP override state -zero_trust.yaml,/accounts/{account_id}/devices/revoke,devices-revoke-devices,devices_revoke_devices,post,teamsDevicesApiResponseSingle,Devices,devices,devices_revoke,revoke_by_account,exec,,Revoke devices (deprecated) +zero_trust.yaml,/accounts/{account_id}/devices/revoke,devices-revoke-devices,devices_revoke_devices,post,teamsDevicesApiResponseSingle,Devices,devices,devices,revoke,exec,,Revoke devices (deprecated) zero_trust.yaml,/accounts/{account_id}/devices/settings,zero-trust-accounts-delete-device-settings-for-zero-trust-account,zero_trust_accounts_delete_device_settings_for_zero_trust_account,delete,teamsDevicesZeroTrustAccountDeviceSettingsResponse,Zero Trust accounts,zero_trust_accounts,devices_settings,delete,delete,,Reset device settings for a Zero Trust account with defaults. This turns off all proxying. zero_trust.yaml,/accounts/{account_id}/devices/settings,zero-trust-accounts-get-device-settings-for-zero-trust-account,zero_trust_accounts_get_device_settings_for_zero_trust_account,get,teamsDevicesZeroTrustAccountDeviceSettingsResponse,Zero Trust accounts,zero_trust_accounts,devices_settings,list,select,$.result,Get device settings for a Zero Trust account zero_trust.yaml,/accounts/{account_id}/devices/settings,zero-trust-accounts-patch-device-settings-for-the-zero-trust-account,zero_trust_accounts_patch_device_settings_for_the_zero_trust_account,patch,teamsDevicesZeroTrustAccountDeviceSettingsResponse,Zero Trust accounts,zero_trust_accounts,devices_settings,edit,update,,Patch device settings for a Zero Trust account @@ -2567,8 +2567,8 @@ zero_trust.yaml,/accounts/{account_id}/dlp/datasets,dlp-datasets-create,dlp_data zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id},dlp-datasets-delete,dlp_datasets_delete,delete,,DLP Datasets,dlp_datasets,datasets,delete,delete,,Delete a dataset zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id},dlp-datasets-read,dlp_datasets_read,get,,DLP Datasets,dlp_datasets,datasets,get,select,$.result,Fetch a specific dataset zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id},dlp-datasets-update,dlp_datasets_update,put,,DLP Datasets,dlp_datasets,datasets,update,replace,,Update details about a dataset -zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id}/upload,dlp-datasets-create-version,dlp_datasets_create_version,post,,DLP Datasets,dlp_datasets,upload,create,insert,,Prepare to upload a new version of a dataset -zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version},dlp-datasets-upload-version,dlp_datasets_upload_version,post,,DLP Datasets,dlp_datasets,upload,edit,insert,,Upload a new version of a dataset +zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id}/upload,dlp-datasets-create-version,dlp_datasets_create_version,post,,DLP Datasets,dlp_datasets,datasets,upload_version,exec,,Prepare to upload a new version of a dataset +zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version},dlp-datasets-upload-version,dlp_datasets_upload_version,post,,DLP Datasets,dlp_datasets,datasets,upload_version_data,exec,,Upload a new version of a dataset zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version},dlp-datasets-define-columns,dlp_datasets_define_columns,post,,DLP Datasets,dlp_datasets,datasets,dlp_datasets_define_columns,exec,,Sets the column information for a multi-column upload zero_trust.yaml,/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id},dlp-datasets-upload-dataset-column,dlp_datasets_upload_dataset_column,post,,DLP Datasets,dlp_datasets,entries,create,insert,,Upload a new version of a multi-column dataset zero_trust.yaml,/accounts/{account_id}/dlp/document_fingerprints,dlp-document-fingerprints-read-all,dlp_document_fingerprints_read_all,get,,DLP Document Fingerprints,dlp_document_fingerprints,document_fingerprints,list,select,$.result,Retrieve data about all document fingerprints. @@ -2588,9 +2588,9 @@ zero_trust.yaml,/accounts/{account_id}/dlp/email/rules/{rule_id},dlp-email-scann zero_trust.yaml,/accounts/{account_id}/dlp/entries,dlp-entries-list-all-entries,dlp_entries_list_all_entries,get,,DLP Entries,dlp_entries,dlp_entries,list,select,$.result,List all entries zero_trust.yaml,/accounts/{account_id}/dlp/entries,dlp-entries-create-entry,dlp_entries_create_entry,post,,DLP Entries,dlp_entries,dlp_entries,create,insert,,Create custom entry zero_trust.yaml,/accounts/{account_id}/dlp/entries/custom/{entry_id},dlp-entries-update-custom-entry,dlp_entries_update_custom_entry,put,,DLP Entries,dlp_entries,entries,update_custom,exec,,Update custom entry -zero_trust.yaml,/accounts/{account_id}/dlp/entries/integration,dlp-entries-create-integration-entry,dlp_entries_create_integration_entry,post,,DLP Integration Entries,dlp_integration_entries,integration,create,insert,,Create integration entry -zero_trust.yaml,/accounts/{account_id}/dlp/entries/integration/{entry_id},dlp-entries-delete-integration-entry,dlp_entries_delete_integration_entry,delete,,DLP Integration Entries,dlp_integration_entries,integration,delete,delete,,Delete integration entry -zero_trust.yaml,/accounts/{account_id}/dlp/entries/integration/{entry_id},dlp-entries-update-integration-entry,dlp_entries_update_integration_entry,put,,DLP Integration Entries,dlp_integration_entries,integration,update,replace,,Update integration entry +zero_trust.yaml,/accounts/{account_id}/dlp/entries/integration,dlp-entries-create-integration-entry,dlp_entries_create_integration_entry,post,,DLP Integration Entries,dlp_integration_entries,integrations,create_entry,insert,,Create integration entry +zero_trust.yaml,/accounts/{account_id}/dlp/entries/integration/{entry_id},dlp-entries-delete-integration-entry,dlp_entries_delete_integration_entry,delete,,DLP Integration Entries,dlp_integration_entries,integrations,delete_entry,delete,,Delete integration entry +zero_trust.yaml,/accounts/{account_id}/dlp/entries/integration/{entry_id},dlp-entries-update-integration-entry,dlp_entries_update_integration_entry,put,,DLP Integration Entries,dlp_integration_entries,integrations,update_entry,replace,,Update integration entry zero_trust.yaml,/accounts/{account_id}/dlp/entries/predefined,dlp-entries-create-predefined-entry,dlp_entries_create_predefined_entry,post,,DLP Predefined Entries,dlp_predefined_entries,entries_predefined,create,insert,,Create predefined entry zero_trust.yaml,/accounts/{account_id}/dlp/entries/predefined/{entry_id},dlp-entries-delete-predefined-entry,dlp_entries_delete_predefined_entry,delete,,DLP Predefined Entries,dlp_predefined_entries,entries_predefined,delete_by_account,delete,,Delete predefined entry zero_trust.yaml,/accounts/{account_id}/dlp/entries/predefined/{entry_id},dlp-entries-update-predefined-entry,dlp_entries_update_predefined_entry,put,,DLP Entries,dlp_entries,entries_predefined,update_by_account,replace,,Update predefined entry @@ -2731,12 +2731,12 @@ zero_trust.yaml,/accounts/{account_id}/zt_risk_scoring/{user_id},dlp-risk-score- zero_trust.yaml,/accounts/{account_id}/zt_risk_scoring/{user_id}/reset,dlp-risk-score-reset-post,dlp_risk_score_reset_post,post,,Zero Trust Risk Scoring,zero_trust_risk_scoring,risk_scoring,reset,exec,,Clear the risk score for a particular user zero_trust.yaml,/zones/{zone_id}/access/apps,get_zones_zone_id_access_apps,get_zones_zone_id_access_apps,get,accessAppsComponentsSchemasResponseCollection,,,applications,list,select,$.result,List Access applications zero_trust.yaml,/zones/{zone_id}/access/apps,post_zones_zone_id_access_apps,post_zones_zone_id_access_apps,post,,,,applications,create_by_zone,insert,,Add an Access application -zero_trust.yaml,/zones/{zone_id}/access/apps/ca,get_zones_zone_id_access_apps_ca,get_zones_zone_id_access_apps_ca,get,accessCaComponentsSchemasResponseCollection,,,cas_c5c46c,list_by_zone,select,$.result,List short-lived certificate CAs +zero_trust.yaml,/zones/{zone_id}/access/apps/ca,get_zones_zone_id_access_apps_ca,get_zones_zone_id_access_apps_ca,get,accessCaComponentsSchemasResponseCollection,,,cas,list_by_zone,select,$.result,List short-lived certificate CAs zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id},delete_zones_zone_id_access_apps_app_id,delete_zones_zone_id_access_apps_app_id,delete,accessIdResponse,,,applications,delete_by_zone,delete,,Delete an Access application zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id},get_zones_zone_id_access_apps_app_id,get_zones_zone_id_access_apps_app_id,get,accessAppsComponentsSchemasSingleResponse,,,access_apps,get_by_zone,select,$.result,Get an Access application zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id},put_zones_zone_id_access_apps_app_id,put_zones_zone_id_access_apps_app_id,put,,,,applications,update_by_zone,replace,,Update an Access application zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id}/ca,delete_zones_zone_id_access_apps_app_id_ca,delete_zones_zone_id_access_apps_app_id_ca,delete,accessSchemasIdResponse,,,cas,delete_by_zone,delete,,Delete a short-lived certificate CA -zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id}/ca,get_zones_zone_id_access_apps_app_id_ca,get_zones_zone_id_access_apps_app_id_ca,get,accessCaComponentsSchemasSingleResponse,,,cas_0145fa,list_by_zone,select,$.result,Get a short-lived certificate CA +zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id}/ca,get_zones_zone_id_access_apps_app_id_ca,get_zones_zone_id_access_apps_app_id_ca,get,accessCaComponentsSchemasSingleResponse,,,cas,get_by_zone,select,$.result,Get a short-lived certificate CA zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id}/ca,post_zones_zone_id_access_apps_app_id_ca,post_zones_zone_id_access_apps_app_id_ca,post,accessCaComponentsSchemasSingleResponse,,,cas,create_by_zone,insert,,Create a short-lived certificate CA zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id}/policies,get_zones_zone_id_access_apps_app_id_policies,get_zones_zone_id_access_apps_app_id_policies,get,accessAppPoliciesComponentsSchemasResponseCollection,,,apps_policies,list_by_zone,select,$.result,List Access application policies zero_trust.yaml,/zones/{zone_id}/access/apps/{app_id}/policies,post_zones_zone_id_access_apps_app_id_policies,post_zones_zone_id_access_apps_app_id_policies,post,accessAppPoliciesComponentsSchemasSingleResponse,,,apps_policies,create_by_zone,insert,,Create an Access application policy @@ -2826,8 +2826,8 @@ zones.yaml,/zones/{zone_id}/settings/{setting_id},zone-settings-get-single-setti zones.yaml,/zones/{zone_id}/settings/{setting_id},zone-settings-edit-single-setting,zone_settings_edit_single_setting,patch,,Zone Settings,zone_settings,settings,edit,update,,Edit zone setting zones.yaml,/zones/{zone_id}/smart_shield,smart-shield-get-settings,smart_shield_get_settings,get,,Smart Shield Settings,smart_shield_settings,smart_shield,list,select,$.result,Get Smart Shield Settings zones.yaml,/zones/{zone_id}/smart_shield,smart-shield-patch-settings,smart_shield_patch_settings,patch,,Smart Shield Settings,smart_shield_settings,smart_shield,smart_shield_patch_settings,update,,Patch Smart Shield Settings -zones.yaml,/zones/{zone_id}/smart_shield/cache_reserve_clear,smart-shield-settings-get-cache-reserve-clear,smart_shield_settings_get_cache_reserve_clear,get,,Cache Reserve Clear,cache_reserve_clear,cache_reserve_clear,list,select,$.result,Get Cache Reserve Clear -zones.yaml,/zones/{zone_id}/smart_shield/cache_reserve_clear,smart-shield-settings-start-cache-reserve-clear,smart_shield_settings_start_cache_reserve_clear,post,,Cache Reserve Clear,cache_reserve_clear,cache_reserve_clear,smart_shield_settings_start_cache_reserve_clear,insert,,Start Cache Reserve Clear +zones.yaml,/zones/{zone_id}/smart_shield/cache_reserve_clear,smart-shield-settings-get-cache-reserve-clear,smart_shield_settings_get_cache_reserve_clear,get,,Cache Reserve Clear,cache_reserve_clear,cache_reserve,get_clear_status,select,$.result,Get Cache Reserve Clear +zones.yaml,/zones/{zone_id}/smart_shield/cache_reserve_clear,smart-shield-settings-start-cache-reserve-clear,smart_shield_settings_start_cache_reserve_clear,post,,Cache Reserve Clear,cache_reserve_clear,cache_reserve,start_clear,exec,,Start Cache Reserve Clear zones.yaml,/zones/{zone_id}/smart_shield/healthchecks,smart-shield-list-health-checks,smart_shield_list_health_checks,get,smartshieldResponseCollection,Health Checks,health_checks,healthchecks,list,select,$.result,List Health Checks zones.yaml,/zones/{zone_id}/smart_shield/healthchecks,smart-shield-create-health-check,smart_shield_create_health_check,post,smartshieldSingleHcResponse,Health Checks,health_checks,healthchecks,smart_shield_create_health_check,insert,,Create Health Check zones.yaml,/zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id},smart-shield-delete-health-check,smart_shield_delete_health_check,delete,smartshieldSingleHcIdResponse,Health Checks,health_checks,healthchecks,smart_shield_delete_health_check,delete,,Delete Health Check diff --git a/stackql_cloudflare/provider-dev/config/select_response_fixes.yaml b/stackql_cloudflare/provider-dev/config/select_response_fixes.yaml new file mode 100644 index 00000000000..5b326a76806 --- /dev/null +++ b/stackql_cloudflare/provider-dev/config/select_response_fixes.yaml @@ -0,0 +1,106 @@ +# Response-shape fixes for resources whose SELECT yields no columns. +# +# Consumed by stackql_cloudflare_provider/select_response_fixes.py (a +# generate-provider post-pass). Each entry targets one operation +# (service yaml + path + verb) and applies one fix kind: +# +# item_schema - replace the untyped `result.items` in the op's 200 +# envelope with the given typed schema (objectKey +# $.result comes from the CSV). Use when the real +# response shape is known but upstream declares +# `{type: object}` items. +# scalar_rows - result is an array of scalars: transform each +# element into a row with the given column name. +# result_to_contents - result is an untyped/dynamic object or bare string: +# project the whole `result` as a single row with a +# `contents` column. +# array_items_contents - result is an array of untyped objects (dynamic row +# shapes, e.g. SQL query rows): one row per element, +# each as a `contents` column. +# contents - project the entire response body as a single +# `contents` row (raw text / NDJSON responses). +# add_200_contents - the op declares no 200 content at all: declare a +# `{contents}` schema and wrap the raw body. +# +# All kinds except item_schema clear the method's objectKey and attach a +# response transform (binary_responses.py pattern). + +fixes: + # --- ai model catalog (typed shapes confirmed live 2026-07-20) --- + - service: ai + path: /accounts/{account_id}/ai/models/search + verb: get + kind: item_schema + schema: + type: object + properties: + id: {type: string, description: Model identifier (UUID).} + source: {type: number} + name: {type: string, description: "Model name, e.g. @cf/meta/llama-3.2-1b-instruct - use as model_name in the ai task-family resources."} + description: {type: string} + task: + type: object + description: "Task grouping: id, name (e.g. Text Generation), description." + created_at: {type: string} + tags: {type: array, items: {type: string}} + properties: {type: array, items: {type: object}} + - service: ai + path: /accounts/{account_id}/ai/tasks/search + verb: get + kind: item_schema + schema: + type: object + properties: + id: {type: string, description: Task identifier (UUID).} + name: {type: string, description: "Task name, e.g. Text Generation."} + description: {type: string} + - service: ai + path: /accounts/{account_id}/ai/authors/search + verb: get + kind: scalar_rows + column: author + + # --- scalar-array results -> rows --- + - service: resource_tagging + path: /accounts/{account_id}/tags/keys + verb: get + kind: scalar_rows + column: key + - service: resource_tagging + path: /accounts/{account_id}/tags/values/{tag_key} + verb: get + kind: scalar_rows + column: value + - service: browser_rendering + path: /accounts/{account_id}/browser-rendering/links + verb: post + kind: scalar_rows + column: link + + # --- untyped / string / dynamic result objects -> contents --- + - {service: ssl, path: "/zones/{zone_id}/ssl/analyze", verb: post, kind: result_to_contents} + - {service: browser_rendering, path: "/accounts/{account_id}/browser-rendering/content", verb: post, kind: result_to_contents} + - {service: browser_rendering, path: "/accounts/{account_id}/browser-rendering/markdown", verb: post, kind: result_to_contents} + - {service: browser_rendering, path: "/accounts/{account_id}/browser-rendering/json", verb: post, kind: result_to_contents} + - {service: alerting, path: "/accounts/{account_id}/alerting/v3/available_alerts", verb: get, kind: result_to_contents} + - {service: zero_trust, path: "/accounts/{account_id}/devices/{device_id}/override_codes", verb: get, kind: result_to_contents} + - {service: zero_trust, path: "/accounts/{account_id}/devices/registrations/{registration_id}/override_codes", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/attackers", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/countries", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/categories", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/targetIndustries", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/indicatorTypes", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/tags", verb: get, kind: result_to_contents} + - {service: cloudforce_one, path: "/accounts/{account_id}/cloudforce-one/events/dataset", verb: get, kind: result_to_contents} + + # --- dynamic row arrays -> one contents row per element --- + - {service: logs, path: "/accounts/{account_id}/logs/explorer/query/sql", verb: post, kind: array_items_contents} + - {service: logs, path: "/zones/{zone_id}/logs/explorer/query/sql", verb: post, kind: array_items_contents} + + # --- raw text / NDJSON bodies -> whole-body contents --- + - {service: logs, path: "/zones/{zone_id}/logs/received", verb: get, kind: contents} + - {service: logs, path: "/zones/{zone_id}/logs/rayids/{ray_id}", verb: get, kind: contents} + + # --- no declared 200 content -> declare + wrap --- + - {service: network_interconnects, path: "/accounts/{account_id}/cni/interconnects/{icon}/loa", verb: get, kind: add_200_contents} + - {service: browser_rendering, path: "/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list", verb: get, kind: add_200_contents} diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/provider.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/provider.yaml index 632322e1526..058929cdd91 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/provider.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/provider.yaml @@ -182,13 +182,13 @@ providerServices: Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). - aisearch: - id: aisearch:v00.00.00000 - name: aisearch + ai_gateway: + id: ai_gateway:v00.00.00000 + name: ai_gateway preferred: true service: - $ref: cloudflare/v00.00.00000/services/aisearch.yaml - title: aisearch API + $ref: cloudflare/v00.00.00000/services/ai_gateway.yaml + title: ai_gateway API version: v00.00.00000 description: >- Welcome to Cloudflare's API documentation site. We are experimenting with @@ -218,13 +218,13 @@ providerServices: Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). - ai_gateway: - id: ai_gateway:v00.00.00000 - name: ai_gateway + ai_search: + id: ai_search:v00.00.00000 + name: ai_search preferred: true service: - $ref: cloudflare/v00.00.00000/services/ai_gateway.yaml - title: ai_gateway API + $ref: cloudflare/v00.00.00000/services/ai_search.yaml + title: ai_search API version: v00.00.00000 description: >- Welcome to Cloudflare's API documentation site. We are experimenting with diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/addressing.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/addressing.yaml index dde40efdcb2..c4030357c88 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/addressing.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/addressing.yaml @@ -4545,29 +4545,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/address_maps/methods/get' - - $ref: '#/components/x-stackQL-resources/address_maps/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/address_maps/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/address_maps/methods/edit' - delete: - - $ref: '#/components/x-stackQL-resources/address_maps/methods/delete' - replace: [] - accounts: - id: cloudflare.addressing.accounts - name: accounts - title: Accounts - methods: - delete: + remove_account: operation: $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1accounts~1{account_id}/delete' response: mediaType: application/json openAPIDocKey: '200' - update: + add_account: config: requestBodyTranslate: algorithm: naive @@ -4576,26 +4560,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts/methods/delete' - replace: - - $ref: '#/components/x-stackQL-resources/accounts/methods/update' - ips: - id: cloudflare.addressing.ips - name: ips - title: Ips - methods: - delete: + remove_ip: operation: $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1ips~1{ip_address}/delete' response: mediaType: application/json openAPIDocKey: '200' - update: + add_ip: config: requestBodyTranslate: algorithm: naive @@ -4604,26 +4575,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/ips/methods/delete' - replace: - - $ref: '#/components/x-stackQL-resources/ips/methods/update' - zones: - id: cloudflare.addressing.zones - name: zones - title: Zones - methods: - delete: + remove_zone: operation: $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1zones~1{zone_id}/delete' response: mediaType: application/json openAPIDocKey: '200' - update: + add_zone: config: requestBodyTranslate: algorithm: naive @@ -4633,13 +4591,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] + select: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/get' + - $ref: '#/components/x-stackQL-resources/address_maps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/edit' delete: - - $ref: '#/components/x-stackQL-resources/zones/methods/delete' - replace: - - $ref: '#/components/x-stackQL-resources/zones/methods/update' + - $ref: '#/components/x-stackQL-resources/address_maps/methods/delete' + replace: [] leases: id: cloudflare.addressing.leases name: leases @@ -4740,6 +4701,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + validate_prefix: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '202' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/prefixes/methods/get' @@ -4925,24 +4892,6 @@ components: delete: - $ref: '#/components/x-stackQL-resources/delegations/methods/delete' replace: [] - validate: - id: cloudflare.addressing.validate - name: validate - title: Validate - methods: - ip_address_management_prefixes_validate_prefix: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1validate/post' - response: - mediaType: application/json - openAPIDocKey: '202' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/validate/methods/ip_address_management_prefixes_validate_prefix' - update: [] - delete: [] - replace: [] regions: id: cloudflare.addressing.regions name: regions diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai.yaml index 0267d2fe616..dc545047f19 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai.yaml @@ -28,27 +28,10 @@ paths: content: application/json: schema: - properties: - errors: - items: - type: object - type: array - messages: - items: - type: string - type: array - result: - items: - type: object - type: array - success: - type: boolean - required: - - success - - result - - errors - - messages type: object + properties: + author: + type: string description: Returns a list of authors '400': content: @@ -705,6 +688,30 @@ paths: result: items: type: object + properties: + id: + type: string + description: Model identifier (UUID). + source: + type: number + name: + type: string + description: Model name, e.g. @cf/meta/llama-3.2-1b-instruct - use as model_name in the ai task-family resources. + description: + type: string + task: + type: object + description: 'Task grouping: id, name (e.g. Text Generation), description.' + created_at: + type: string + tags: + type: array + items: + type: string + properties: + type: array + items: + type: object type: array success: type: boolean @@ -754,10 +761,10 @@ paths: resource_chain: - models method: list - /accounts/{account_id}/ai/run/@cf/ai4bharat/indictrans2-en-indic-1B: + /accounts/{account_id}/ai/run/@cf/facebook/nonomni-detr-resnet-50: post: - description: Runs inference on the @cf/ai4bharat/indictrans2-en-indic-1B model. - operationId: workers-ai-post-run-cf-ai4bharat-indictrans2-en-indic-1B + description: Runs inference on the @cf/facebook/nonomni-detr-resnet-50 model. + operationId: workers-ai-post-run-cf-facebook-nonomni-detr-resnet-50 parameters: - name: account_id in: path @@ -776,57 +783,10 @@ paths: type: string requestBody: content: - application/json: + application/octet-stream: schema: - properties: - target_language: - default: hin_Deva - description: Target langauge to translate to - enum: - - asm_Beng - - awa_Deva - - ben_Beng - - bho_Deva - - brx_Deva - - doi_Deva - - eng_Latn - - gom_Deva - - gon_Deva - - guj_Gujr - - hin_Deva - - hne_Deva - - kan_Knda - - kas_Arab - - kas_Deva - - kha_Latn - - lus_Latn - - mag_Deva - - mai_Deva - - mal_Mlym - - mar_Deva - - mni_Beng - - mni_Mtei - - npi_Deva - - ory_Orya - - pan_Guru - - san_Deva - - sat_Olck - - snd_Arab - - snd_Deva - - tam_Taml - - tel_Telu - - urd_Arab - - unr_Deva - type: string - text: - description: Input text to translate. Can be a single string or a list of strings. - type: string - items: - type: string - required: - - text - - target_language - type: object + format: binary + type: string responses: '200': content: @@ -865,9 +825,9 @@ paths: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/ai4bharat/indictrans2-en-indic-1B model. + summary: Execute @cf/facebook/nonomni-detr-resnet-50 model. tags: - - Workers AI Translation + - Workers AI Object Detection x-api-token-group: - Workers AI Write - Workers AI Read @@ -879,10 +839,10 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/ai4bharat/nonomni-indictrans2-en-indic-1b: + /accounts/{account_id}/ai/run/@cf/microsoft/nonomni-resnet-50: post: - description: Runs inference on the @cf/ai4bharat/nonomni-indictrans2-en-indic-1b model. - operationId: workers-ai-post-run-cf-ai4bharat-nonomni-indictrans2-en-indic-1b + description: Runs inference on the @cf/microsoft/nonomni-resnet-50 model. + operationId: workers-ai-post-run-cf-microsoft-nonomni-resnet-50 parameters: - name: account_id in: path @@ -901,57 +861,10 @@ paths: type: string requestBody: content: - application/json: + application/octet-stream: schema: - properties: - target_language: - default: hin_Deva - description: Target langauge to translate to - enum: - - asm_Beng - - awa_Deva - - ben_Beng - - bho_Deva - - brx_Deva - - doi_Deva - - eng_Latn - - gom_Deva - - gon_Deva - - guj_Gujr - - hin_Deva - - hne_Deva - - kan_Knda - - kas_Arab - - kas_Deva - - kha_Latn - - lus_Latn - - mag_Deva - - mai_Deva - - mal_Mlym - - mar_Deva - - mni_Beng - - mni_Mtei - - npi_Deva - - ory_Orya - - pan_Guru - - san_Deva - - sat_Olck - - snd_Arab - - snd_Deva - - tam_Taml - - tel_Telu - - urd_Arab - - unr_Deva - type: string - text: - description: Input text to translate. Can be a single string or a list of strings. - type: string - items: - type: string - required: - - text - - target_language - type: object + format: binary + type: string responses: '200': content: @@ -990,9 +903,9 @@ paths: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/ai4bharat/nonomni-indictrans2-en-indic-1b model. + summary: Execute @cf/microsoft/nonomni-resnet-50 model. tags: - - Workers AI Translation + - Workers AI Image Classification x-api-token-group: - Workers AI Write - Workers AI Read @@ -1004,10 +917,10 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/aisingapore/gemma-sea-lion-v4-27b-it: + /accounts/{account_id}/ai/run/@cf/microsoft/resnet-50: post: - description: Runs inference on the @cf/aisingapore/gemma-sea-lion-v4-27b-it model. - operationId: workers-ai-post-run-cf-aisingapore-gemma-sea-lion-v4-27b-it + description: Runs inference on the @cf/microsoft/resnet-50 model. + operationId: workers-ai-post-run-cf-microsoft-resnet-50 parameters: - name: account_id in: path @@ -1026,377 +939,35 @@ paths: type: string requestBody: content: - application/json: + application/octet-stream: schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 2000 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - requests: - items: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: type: object success: type: boolean @@ -1410,9 +981,9 @@ paths: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/aisingapore/gemma-sea-lion-v4-27b-it model. + summary: Execute @cf/microsoft/resnet-50 model. tags: - - Workers AI Text Generation + - Workers AI Image Classification x-api-token-group: - Workers AI Write - Workers AI Read @@ -1424,10 +995,10 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/bge-base-en-v1.5: + /accounts/{account_id}/ai/run/@cf/openai/whisper: post: - description: Runs inference on the @cf/baai/bge-base-en-v1.5 model. - operationId: workers-ai-post-run-cf-baai-bge-base-en-v1-5 + description: Runs inference on the @cf/openai/whisper model. + operationId: workers-ai-post-run-cf-openai-whisper parameters: - name: account_id in: path @@ -1446,46 +1017,10 @@ paths: type: string requestBody: content: - application/json: + application/octet-stream: schema: - type: object - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object - type: array + format: binary + type: string responses: '200': content: @@ -1524,9 +1059,9 @@ paths: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/bge-base-en-v1.5 model. + summary: Execute @cf/openai/whisper model. tags: - - Workers AI Text Embeddings + - Workers AI Automatic Speech Recognition x-api-token-group: - Workers AI Write - Workers AI Read @@ -1538,10 +1073,10 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/bge-large-en-v1.5: + /accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en: post: - description: Runs inference on the @cf/baai/bge-large-en-v1.5 model. - operationId: workers-ai-post-run-cf-baai-bge-large-en-v1-5 + description: Runs inference on the @cf/openai/whisper-tiny-en model. + operationId: workers-ai-post-run-cf-openai-whisper-tiny-en parameters: - name: account_id in: path @@ -1560,46 +1095,10 @@ paths: type: string requestBody: content: - application/json: + application/octet-stream: schema: - type: object - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object - type: array + format: binary + type: string responses: '200': content: @@ -1638,9 +1137,9 @@ paths: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/bge-large-en-v1.5 model. + summary: Execute @cf/openai/whisper-tiny-en model. tags: - - Workers AI Text Embeddings + - Workers AI Automatic Speech Recognition x-api-token-group: - Workers AI Write - Workers AI Read @@ -1652,10 +1151,10 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/bge-m3: + /accounts/{account_id}/ai/run/{model_name}: post: - description: Runs inference on the @cf/baai/bge-m3 model. - operationId: workers-ai-post-run-cf-baai-bge-m3 + description: This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + operationId: workers-ai-post-run-model parameters: - name: account_id in: path @@ -1663,86 +1162,261 @@ paths: description: The Cloudflare account ID. schema: type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags + - in: path + name: model_name schema: type: string + required: true requestBody: content: application/json: schema: type: object - title: Input Query and Contexts + title: Text Classification properties: - contexts: - description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. + text: + description: The text that you want to classify + minLength: 1 + type: string + guidance: + default: 7.5 + description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values items: - properties: - text: - description: One of the provided context content - minLength: 1 - type: string - type: object + description: A value between 0 and 255 + type: number type: array - query: - description: A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts + image_b64: + description: For use with img2img tasks. A base64-encoded string of the input image + type: string + mask: + description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: The number of diffusion steps; higher values can improve quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate minLength: 1 type: string - truncate_inputs: - default: false - description: When provided with too long context should the model error out or truncate the context to fit? - type: boolean - text: + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + lang: + default: en + description: The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue + audio: + description: An array of integers that represent the audio data constrained to 8-bit unsigned integer values items: - type: object - title: Input Query and Contexts - properties: - contexts: - description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. - items: - properties: - text: - description: One of the provided context content - minLength: 1 - type: string - type: object - type: array - query: - description: A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts - minLength: 1 - type: string - truncate_inputs: - default: false - description: When provided with too long context should the model error out or truncate the context to fit? - type: boolean - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - type: array + description: A value between 0 and 255 + type: number + type: array + source_lang: + description: The language of the recorded audio + type: string + target_lang: + description: The language to translate the transcription into. Currently only English is supported. + type: string + frequency_penalty: + description: Decreases the likelihood of the model repeating the same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: Increases the likelihood of the model introducing new topics. + maximum: 2 + minimum: -2 + type: number + raw: + default: false + description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: Penalty for repeated tokens; higher values discourage repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + stream: + default: false + description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: Controls the randomness of the output; higher values produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: An array of message objects representing the conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: Schema defining the parameters accepted by the function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + type: array + input_text: + description: The text that you want the model to summarize + minLength: 1 + type: string + max_length: + default: 1024 + description: The maximum length of the generated summary in tokens + type: integer + ignore_eos: + description: Whether to ignore the EOS token and continue generating tokens after the EOS token is generated. + type: boolean responses: '200': content: application/json: schema: - type: object - description: Object with user data. + $ref: '#/components/schemas/stackqlAiRunResponseEnvelope' + description: Model response '400': content: application/json: @@ -1751,12 +1425,9 @@ paths: errors: items: properties: - code: - type: string message: type: string required: - - code - message type: object type: array @@ -1765,18 +1436,18 @@ paths: success: type: boolean required: - - errors - - success - result + - success + - errors type: object - description: Bad request + description: Bad Request security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/bge-m3 model. + summary: Execute AI model tags: - - Workers AI Text Embeddings + - Workers AI x-api-token-group: - Workers AI Write - Workers AI Read @@ -1788,10 +1459,14 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/bge-reranker-base: - post: - description: Runs inference on the @cf/baai/bge-reranker-base model. - operationId: workers-ai-post-run-cf-baai-bge-reranker-base + x-stackql-sdk: + service: ai + resource_chain: [] + method: run + /accounts/{account_id}/ai/tasks/search: + get: + description: Searches Workers AI models by task type (e.g., text-generation, embeddings). + operationId: workers-ai-search-task parameters: - name: account_id in: path @@ -1799,197 +1474,66 @@ paths: description: The Cloudflare account ID. schema: type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - contexts: - description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. - items: - properties: - text: - description: One of the provided context content - minLength: 1 - type: string - type: object - type: array - query: - description: A query you wish to perform against the provided contexts. - minLength: 1 - type: string - top_k: - description: Number of returned results starting with the best score. - minimum: 1 - type: integer - required: - - query - - contexts - type: object responses: '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': content: application/json: schema: properties: errors: items: + type: object + type: array + messages: + items: + type: string + type: array + result: + items: + type: object properties: - code: + id: type: string - message: + description: Task identifier (UUID). + name: + type: string + description: Task name, e.g. Text Generation. + description: type: string - required: - - code - - message - type: object type: array - result: - type: object success: type: boolean + x-auditable: true required: - - errors - success - result + - errors + - messages type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/baai/bge-reranker-base model. - tags: - - Workers AI Text Classification - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/baai/bge-small-en-v1.5: - post: - description: Runs inference on the @cf/baai/bge-small-en-v1.5 model. - operationId: workers-ai-post-run-cf-baai-bge-small-en-v1-5 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object - type: array - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': + description: Returns a list of tasks + '404': content: application/json: schema: properties: errors: items: - properties: - code: - type: string - message: - type: string - required: - - code - - message type: object type: array - result: - type: object success: type: boolean required: - - errors - success - - result + - errors type: object - description: Bad request + description: Object not found security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/bge-small-en-v1.5 model. + summary: Task Search tags: - - Workers AI Text Embeddings + - Workers AI x-api-token-group: - Workers AI Write - Workers AI Read @@ -2001,10 +1545,15 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-base-en-v1.5: + x-stackql-sdk: + service: ai + resource_chain: + - tasks + method: list + /accounts/{account_id}/ai/tomarkdown: post: - description: Runs inference on the @cf/baai/nonomni-bge-base-en-v1.5 model. - operationId: workers-ai-post-run-cf-baai-nonomni-bge-base-en-v1-5 + description: Converts uploaded files into Markdown format using Workers AI. + operationId: workers-ai-post-to-markdown parameters: - name: account_id in: path @@ -2012,64 +1561,58 @@ paths: description: The Cloudflare account ID. schema: type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string requestBody: content: - application/json: + multipart/form-data: schema: - type: object properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed + files: items: - description: The text to embed - minLength: 1 + format: binary type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object type: array + required: + - files + type: object responses: '200': content: application/json: schema: + properties: + result: + items: + properties: + data: + type: string + x-auditable: true + format: + type: string + x-auditable: true + mimeType: + type: string + x-auditable: true + name: + type: string + x-auditable: true + tokens: + type: string + x-auditable: true + required: + - name + - mimeType + - format + - tokens + - data + type: object + type: array + success: + type: boolean + required: + - success + - result type: object - description: Object with user data. + description: Model Schema '400': content: application/json: @@ -2078,12 +1621,9 @@ paths: errors: items: properties: - code: - type: string message: type: string required: - - code - message type: object type: array @@ -2092,18 +1632,18 @@ paths: success: type: boolean required: - - errors - - success - result + - success + - errors type: object - description: Bad request + description: Bad Request security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/nonomni-bge-base-en-v1.5 model. + summary: Convert Files into Markdown tags: - - Workers AI Text Embeddings + - Workers AI x-api-token-group: - Workers AI Write - Workers AI Read @@ -2115,10 +1655,10 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-large-en-v1.5: - post: - description: Runs inference on the @cf/baai/nonomni-bge-large-en-v1.5 model. - operationId: workers-ai-post-run-cf-baai-nonomni-bge-large-en-v1-5 + /accounts/{account_id}/ai/tomarkdown/supported: + get: + description: Lists all file formats supported for conversion to Markdown. + operationId: workers-ai-get-to-markdown-supported parameters: - name: account_id in: path @@ -2126,64 +1666,33 @@ paths: description: The Cloudflare account ID. schema: type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object - type: array responses: '200': content: application/json: schema: + properties: + result: + items: + properties: + extension: + type: string + x-auditable: true + mimeType: + type: string + x-auditable: true + required: + - extension + - mimeType + type: object + type: array + success: + type: boolean + required: + - success + - result type: object - description: Object with user data. + description: Successful response '400': content: application/json: @@ -2192,12 +1701,9 @@ paths: errors: items: properties: - code: - type: string message: type: string required: - - code - message type: object type: array @@ -2206,18 +1712,18 @@ paths: success: type: boolean required: - - errors - - success - result + - success + - errors type: object - description: Bad request + description: Bad Request security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/nonomni-bge-large-en-v1.5 model. + summary: Get all converted formats supported tags: - - Workers AI Text Embeddings + - Workers AI x-api-token-group: - Workers AI Write - Workers AI Read @@ -2229,98 +1735,195 @@ paths: enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-m3: + x-stackql-sdk: + service: ai + resource_chain: + - to_markdown + method: supported + /accounts/{account_id}/autorag/rags/{id}/ai-search: post: - description: Runs inference on the @cf/baai/nonomni-bge-m3 model. - operationId: workers-ai-post-run-cf-baai-nonomni-bge-m3 + operationId: autorag-config-ai-search parameters: - - name: account_id + - name: id in: path required: true - description: The Cloudflare account ID. + description: Resource ID. schema: type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: type: string requestBody: content: application/json: schema: - type: object - title: Input Query and Contexts properties: - contexts: - description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. - items: - properties: - text: - description: One of the provided context content - minLength: 1 - type: string - type: object - type: array + filters: + type: object + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + filters: + items: + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + required: + - key + - type + - value + type: object + type: array + required: + - type + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano query: - description: A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts - minLength: 1 type: string - truncate_inputs: + ranking_options: + default: {} + properties: + ranker: + type: string + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + type: object + reranking: + properties: + enabled: + default: false + type: boolean + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + rewrite_query: default: false - description: When provided with too long context should the model error out or truncate the context to fit? type: boolean - text: + stream: + default: false + type: boolean + system_prompt: type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - type: object - title: Input Query and Contexts + required: + - query + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: properties: - contexts: - description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. + data: items: properties: - text: - description: One of the provided context content - minLength: 1 + attributes: + type: object + content: + items: + properties: + text: + type: string + type: + type: string + type: object + type: array + file_id: + type: string + filename: type: string + score: + type: number + required: + - score type: object type: array - query: - description: A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts - minLength: 1 - type: string - truncate_inputs: + has_more: default: false - description: When provided with too long context should the model error out or truncate the context to fit? type: boolean - text: + next_page: + nullable: true type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - type: array - responses: - '200': - content: - application/json: - schema: + object: + type: string + response: + type: string + search_query: + type: string + required: + - search_query + - response + type: object + success: + type: boolean + required: + - success + - result type: object - description: Object with user data. - '400': + description: Returns the log details + '404': content: application/json: schema: @@ -2329,7 +1932,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2337,39 +1940,42 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result + - errors type: object - description: Bad request + description: Not Found security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/baai/nonomni-bge-m3 model. + summary: AI Search tags: - - Workers AI Text Embeddings + - AutoRAG RAG Search x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-small-en-v1.5: - post: - description: Runs inference on the @cf/baai/nonomni-bge-small-en-v1.5 model. - operationId: workers-ai-post-run-cf-baai-nonomni-bge-small-en-v1-5 + /accounts/{account_id}/autorag/rags/{id}/files: + get: + operationId: autorag-config-files parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string - name: account_id in: path required: true @@ -2377,64 +1983,76 @@ paths: schema: type: string - in: query - name: queueRequest + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + - in: query + name: search schema: type: string - x-auditable: true - in: query - name: tags + name: status schema: + enum: + - completed + - queued + - running + - error type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - pooling: - default: mean - description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. - enum: - - mean - - cls - type: string - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object - type: array responses: '200': content: application/json: schema: + properties: + result: + items: + properties: + error: + type: string + key: + type: string + required: + - key + - error + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + default: 20 + maximum: 50 + minimum: 5 + type: integer + total_count: + type: integer + required: + - count + - page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info type: object - description: Object with user data. - '400': + description: Returns the AI Search files + '404': content: application/json: schema: @@ -2443,7 +2061,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2451,80 +2069,16 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/baai/nonomni-bge-small-en-v1.5 model. - tags: - - Workers AI Text Embeddings - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-1-schnell: - post: - description: Runs inference on the @cf/black-forest-labs/flux-1-schnell model. - operationId: workers-ai-post-run-cf-black-forest-labs-flux-1-schnell - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - prompt: - description: A text description of the image you want to generate. - maxLength: 2048 - minLength: 1 - type: string - steps: - default: 4 - description: The number of diffusion steps; higher values can improve quality but take longer. - maximum: 8 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: + - errors type: object - description: Object with user data. - '400': + description: autorag_not_found + '503': content: application/json: schema: @@ -2533,7 +2087,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2541,39 +2095,43 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result + - errors type: object - description: Bad request + description: unable_to_connect_to_autorag security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/black-forest-labs/flux-1-schnell model. + summary: Files tags: - - Workers AI Text To Image + - AutoRAG RAG x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write + - Auto Rag Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-2-dev: - post: - description: Runs inference on the @cf/black-forest-labs/flux-2-dev model. - operationId: workers-ai-post-run-cf-black-forest-labs-flux-2-dev + /accounts/{account_id}/autorag/rags/{id}/jobs: + get: + operationId: autorag-config-list-jobs parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string - name: account_id in: path required: true @@ -2581,37 +2139,72 @@ paths: schema: type: string - in: query - name: queueRequest + name: page schema: - type: string - x-auditable: true + default: 1 + minimum: 1 + type: integer - in: query - name: tags + name: per_page schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - multipart: - properties: - body: - type: object - contentType: - type: string - type: object - required: - - multipart - type: object + default: 20 + maximum: 50 + minimum: 0 + type: integer responses: '200': content: application/json: schema: + properties: + result: + items: + properties: + end_reason: + type: string + ended_at: + type: string + id: + type: string + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + started_at: + type: string + required: + - id + - source + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info type: object - description: Object with user data. - '400': + description: Returns a list of AutoRAG Jobs + '404': content: application/json: schema: @@ -2620,7 +2213,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2628,77 +2221,116 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: + - success - errors + type: object + description: autorag_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: - success - - result + - errors type: object - description: Bad request + description: unable_to_connect_to_autorag security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/black-forest-labs/flux-2-dev model. + summary: List Jobs tags: - - Workers AI Text To Image + - AutoRAG Jobs x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write + - Auto Rag Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-2-klein-4b: - post: - description: Runs inference on the @cf/black-forest-labs/flux-2-klein-4b model. - operationId: workers-ai-post-run-cf-black-forest-labs-flux-2-klein-4b - parameters: - - name: account_id + /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}: + get: + operationId: autorag-config-get-job + parameters: + - name: id in: path required: true - description: The Cloudflare account ID. + description: Resource ID. schema: type: string - - in: query - name: queueRequest + - name: job_id + in: path + required: true + description: The job ID. schema: type: string - x-auditable: true - - in: query - name: tags + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: type: string - requestBody: - content: - application/json: - schema: - properties: - multipart: - properties: - body: - type: object - contentType: - type: string - type: object - required: - - multipart - type: object responses: '200': content: application/json: schema: + properties: + result: + properties: + end_reason: + type: string + ended_at: + type: string + id: + type: string + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result type: object - description: Object with user data. - '400': + description: Returns a AutoRAG Job Details + '404': content: application/json: schema: @@ -2707,7 +2339,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2715,39 +2347,75 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: + - success - errors + type: object + description: job_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: - success - - result + - errors type: object - description: Bad request + description: unable_to_connect_to_autorag security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/black-forest-labs/flux-2-klein-4b model. + summary: Get a Job Details tags: - - Workers AI Text To Image + - AutoRAG Jobs x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write + - Auto Rag Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-2-klein-9b: - post: - description: Runs inference on the @cf/black-forest-labs/flux-2-klein-9b model. - operationId: workers-ai-post-run-cf-black-forest-labs-flux-2-klein-9b + /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}/logs: + get: + operationId: autorag-config-list-job-logs parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string - name: account_id in: path required: true @@ -2755,37 +2423,68 @@ paths: schema: type: string - in: query - name: queueRequest + name: page schema: - type: string - x-auditable: true + default: 1 + minimum: 1 + type: integer - in: query - name: tags + name: per_page schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - multipart: - properties: - body: - type: object - contentType: - type: string - type: object - required: - - multipart - type: object + default: 20 + maximum: 500 + minimum: 0 + type: integer responses: '200': content: application/json: schema: + properties: + result: + items: + properties: + created_at: + type: number + readOnly: true + id: + type: integer + message: + type: string + message_type: + type: integer + required: + - id + - message + - message_type + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info type: object - description: Object with user data. - '400': + description: Returns a list of AutoRAG Job Logs + '404': content: application/json: schema: @@ -2794,7 +2493,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2802,52 +2501,73 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: + - success - errors + type: object + description: autorag_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: - success - - result + - errors type: object - description: Bad request + description: unable_to_connect_to_autorag security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/black-forest-labs/flux-2-klein-9b model. + summary: List Job Logs tags: - - Workers AI Text To Image + - AutoRAG Jobs x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write + - Auto Rag Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/bytedance/stable-diffusion-xl-lightning: + /accounts/{account_id}/autorag/rags/{id}/search: post: - description: Runs inference on the @cf/bytedance/stable-diffusion-xl-lightning model. - operationId: workers-ai-post-run-cf-bytedance-stable-diffusion-xl-lightning + operationId: autorag-config-search parameters: - - name: account_id + - name: id in: path required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest + description: Resource ID. schema: type: string - x-auditable: true - - in: query - name: tags + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: type: string requestBody: @@ -2855,69 +2575,133 @@ paths: application/json: schema: properties: - guidance: - default: 7.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - type: number - height: - description: The height of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - image: - description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - image_b64: - description: For use with img2img tasks. A base64-encoded string of the input image - type: string - mask: - description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - negative_prompt: - description: Text describing elements to avoid in the generated image - type: string - num_steps: - default: 20 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 20 + filters: + type: object + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + filters: + items: + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + required: + - key + - type + - value + type: object + type: array + required: + - type + max_num_results: + default: 10 + maximum: 50 + minimum: 1 type: integer - prompt: - description: A text description of the image you want to generate - minLength: 1 + query: type: string - seed: - description: Random seed for reproducibility of the image generation - type: integer - strength: - default: 1 - description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - type: number - width: - description: The width of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer + ranking_options: + default: {} + properties: + ranker: + type: string + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + type: object + reranking: + properties: + enabled: + default: false + type: boolean + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + rewrite_query: + default: false + type: boolean required: - - prompt + - query type: object responses: '200': content: application/json: schema: + properties: + result: + properties: + data: + items: + properties: + attributes: + type: object + content: + items: + properties: + text: + type: string + type: + type: string + type: object + type: array + file_id: + type: string + filename: + type: string + score: + type: number + required: + - score + type: object + type: array + has_more: + default: false + type: boolean + next_page: + nullable: true + type: string + object: + type: string + search_query: + type: string + required: + - search_query + type: object + success: + type: boolean + required: + - success + - result type: object - image/png: - schema: - format: binary - type: string - description: Object with user data. - '400': + description: Returns the log details + '404': content: application/json: schema: @@ -2926,7 +2710,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -2934,117 +2718,68 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result + - errors type: object - description: Bad request + description: Not Found security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/bytedance/stable-diffusion-xl-lightning model. + summary: Search tags: - - Workers AI Text To Image + - AutoRAG RAG Search x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/deepgram/aura-1: - post: - description: Runs inference on the @cf/deepgram/aura-1 model. - operationId: workers-ai-post-run-cf-deepgram-aura-1 + /accounts/{account_id}/autorag/rags/{id}/sync: + patch: + operationId: autorag-config-sync parameters: - - name: account_id + - name: id in: path required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest + description: Resource ID. schema: type: string - x-auditable: true - - in: query - name: tags + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: type: string - requestBody: - content: - application/json: - schema: - properties: - bit_rate: - description: The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. - type: number - container: - description: Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. - enum: - - none - - wav - - ogg - type: string - encoding: - description: Encoding of the output audio. - enum: - - linear16 - - flac - - mulaw - - alaw - - mp3 - - opus - - aac - type: string - sample_rate: - description: Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable - type: number - speaker: - default: angus - description: Speaker used to produce the audio. - enum: - - angus - - asteria - - arcas - - orion - - orpheus - - athena - - luna - - zeus - - perseus - - helios - - hera - - stella - type: string - text: - description: The text content to be converted to speech - type: string - required: - - text - type: object responses: '200': content: application/json: schema: + properties: + result: + properties: + job_id: + type: string + required: + - job_id + type: object + success: + type: boolean + required: + - success + - result type: object - audio/mpeg: - schema: - format: binary - type: string - description: Object with user data. + description: Returns the autorag sync status '400': content: application/json: @@ -3054,7 +2789,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -3062,146 +2797,16 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result + - errors type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/deepgram/aura-1 model. - tags: - - Workers AI Text To Speech - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/deepgram/aura-2-en: - post: - description: Runs inference on the @cf/deepgram/aura-2-en model. - operationId: workers-ai-post-run-cf-deepgram-aura-2-en - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - bit_rate: - description: The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. - type: number - container: - description: Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. - enum: - - none - - wav - - ogg - type: string - encoding: - description: Encoding of the output audio. - enum: - - linear16 - - flac - - mulaw - - alaw - - mp3 - - opus - - aac - type: string - sample_rate: - description: Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable - type: number - speaker: - default: luna - description: Speaker used to produce the audio. - enum: - - amalthea - - andromeda - - apollo - - arcas - - aries - - asteria - - athena - - atlas - - aurora - - callista - - cora - - cordelia - - delia - - draco - - electra - - harmonia - - helena - - hera - - hermes - - hyperion - - iris - - janus - - juno - - jupiter - - luna - - mars - - minerva - - neptune - - odysseus - - ophelia - - orion - - orpheus - - pandora - - phoebe - - pluto - - saturn - - thalia - - theia - - vesta - - zeus - type: string - text: - description: The text content to be converted to speech - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - audio/mpeg: - schema: - format: binary - type: string - description: Object with user data. - '400': + description: autorag_is_paused + '404': content: application/json: schema: @@ -3210,7 +2815,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -3218,116 +2823,16 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/deepgram/aura-2-en model. - tags: - - Workers AI Text To Speech - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/deepgram/aura-2-es: - post: - description: Runs inference on the @cf/deepgram/aura-2-es model. - operationId: workers-ai-post-run-cf-deepgram-aura-2-es - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - bit_rate: - description: The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. - type: number - container: - description: Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. - enum: - - none - - wav - - ogg - type: string - encoding: - description: Encoding of the output audio. - enum: - - linear16 - - flac - - mulaw - - alaw - - mp3 - - opus - - aac - type: string - sample_rate: - description: Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable - type: number - speaker: - default: aquila - description: Speaker used to produce the audio. - enum: - - sirio - - nestor - - carina - - celeste - - alvaro - - diana - - aquila - - selena - - estrella - - javier - type: string - text: - description: The text content to be converted to speech - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: + - errors type: object - audio/mpeg: - schema: - format: binary - type: string - description: Object with user data. - '400': + description: autorag_not_found + '429': content: application/json: schema: @@ -3336,7 +2841,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -3344,103 +2849,16 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/deepgram/aura-2-es model. - tags: - - Workers AI Text To Speech - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/deepgram/flux: - post: - description: Runs inference on the @cf/deepgram/flux model. - operationId: workers-ai-post-run-cf-deepgram-flux - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - eager_eot_threshold: - description: End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9. - type: string - encoding: - description: Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM. - enum: - - linear16 - type: string - eot_threshold: - default: '0.7' - description: End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9. - type: string - eot_timeout_ms: - default: '5000' - description: A turn will be finished when this much time has passed after speech, regardless of EOT confidence. - type: string - keyterm: - description: Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms. - type: string - mip_opt_out: - default: 'false' - description: Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip - enum: - - 'true' - - 'false' - type: string - sample_rate: - description: Sample rate of the audio stream in Hz. - type: string - tag: - description: Label your requests for the purpose of identification during usage reporting - type: string - required: - - sample_rate - - encoding - type: object - responses: - '200': - content: - application/json: - schema: + - errors type: object - description: Object with user data. - '400': + description: sync_in_cooldown + '503': content: application/json: schema: @@ -3449,7 +2867,7 @@ paths: items: properties: code: - type: string + type: number message: type: string required: @@ -3457,23607 +2875,2406 @@ paths: - message type: object type: array - result: - type: object success: + enum: + - false type: boolean required: - - errors - success - - result + - errors type: object - description: Bad request + description: unable_to_connect_to_autorag security: - api_token: [] - api_email: [] api_key: [] - summary: Execute @cf/deepgram/flux model. + summary: Sync tags: - - Workers AI Automatic Speech Recognition + - AutoRAG RAG x-api-token-group: - - Workers AI Write - - Workers AI Read + - Auto Rag Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.ai + - com.cloudflare.api.account.rag x-cfPlanAvailability: business: true enterprise: true free: true pro: true - /accounts/{account_id}/ai/run/@cf/deepgram/nova-3: - post: - description: Runs inference on the @cf/deepgram/nova-3 model. - operationId: workers-ai-post-run-cf-deepgram-nova-3 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: +components: + schemas: + stackqlWorkersAiPostRunCfFacebookNonomniDetrResnet50Body: + type: object + required: + - value + properties: + value: + format: binary + type: string + stackqlWorkersAiPostRunCfMicrosoftNonomniResnet50Body: + type: object + required: + - value + properties: + value: + format: binary + type: string + stackqlWorkersAiPostRunCfMicrosoftResnet50Body: + type: object + required: + - value + properties: + value: + format: binary + type: string + stackqlWorkersAiPostRunCfOpenaiWhisperBody: + type: object + required: + - value + properties: + value: + format: binary + type: string + stackqlWorkersAiPostRunCfOpenaiWhisperTinyEnBody: + type: object + required: + - value + properties: + value: + format: binary + type: string + stackqlAiRunResponseEnvelope: + type: object + description: Union response envelope for Workers AI run operations (synthesised by stackql). + properties: + result: + type: object + properties: + model: + type: string + description: Echo of the model name, where reported. + response: + type: string + description: The generated text response from the model. + usage: + type: object + description: Token usage counts (prompt_tokens, completion_tokens, total_tokens). + tool_calls: + type: array + items: + type: object + description: Tool call requests emitted by the model, if tools were provided. + shape: + type: array + items: + type: integer + description: Dimensions of the returned embedding matrix. + data: + type: array + items: + type: array + items: + type: number + description: Embedding vectors, one per input text. + pooling: + type: string + description: Pooling method used (cls or mean), where applicable. + text: + type: string + description: The transcribed text. + word_count: + type: number + description: Number of words in the transcription, where reported. + words: + type: array + items: + type: object + description: Per-word timing detail, where reported. + vtt: + type: string + description: WebVTT formatted transcription, where reported. + transcription_info: + type: object + description: Model/language detail, where reported. + translated_text: + type: string + description: The translated text. + summary: + type: string + description: The summarized text. + success: + type: boolean + errors: + type: array + items: + type: object + messages: + type: array + items: + type: string + contents: + type: string + description: Raw response payload (binary or non-object results), used by contents-mode families. + stackqlAiTextGenerationRunInput: + type: object + description: Union of request properties across the text_generation member models (synthesised by stackql). + properties: + frequency_penalty: + description: Decreases the likelihood of the model repeating the same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. type: string - x-auditable: true - - in: query - name: tags - schema: + max_tokens: + default: 2000 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: Increases the likelihood of the model introducing new topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 type: string - requestBody: - content: - application/json: - schema: - properties: - audio: - properties: - body: - type: object - contentType: - type: string - required: - - body - - contentType - type: object - channels: - description: The number of channels in the submitted audio - type: number - custom_intent: - description: Custom intents you want the model to detect within your input audio if present - type: string - custom_intent_mode: - description: Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param - enum: - - extended - - strict - type: string - custom_topic: - description: Custom topics you want the model to detect within your input audio or text if present Submit up to 100 - type: string - custom_topic_mode: - description: Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. - enum: - - extended - - strict - type: string - detect_entities: - description: Identifies and extracts key entities from content in submitted audio - type: boolean - detect_language: - description: Identifies the dominant language spoken in submitted audio - type: boolean - diarize: - description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 - type: boolean - dictation: - description: Identify and extract key entities from content in submitted audio - type: boolean - encoding: - description: Specify the expected encoding of your submitted audio - enum: - - linear16 - - flac - - mulaw - - amr-nb - - amr-wb - - opus - - speex - - g729 - type: string - endpointing: - description: Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing - type: string - extra: - description: Arbitrary key-value pairs that are attached to the API response for usage in downstream processing - type: string - filler_words: - description: Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um' - type: boolean - interim_results: - description: 'Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets.' - type: boolean - keyterm: - description: Key term prompting can boost or suppress specialized terminology and brands. - type: string - keywords: - description: Keywords can boost or suppress specialized terminology and brands. - type: string - language: - description: The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available. - type: string - measurements: - description: Spoken measurements will be converted to their corresponding abbreviations. - type: boolean - mip_opt_out: - description: Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip. - type: boolean - mode: - description: Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio - enum: - - general - - medical - - finance - type: string - multichannel: - description: Transcribe each audio channel independently. - type: boolean - numerals: - description: Numerals converts numbers from written format to numerical format. - type: boolean - paragraphs: - description: Splits audio into paragraphs to improve transcript readability. - type: boolean - profanity_filter: - description: Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely. - type: boolean - punctuate: - description: Add punctuation and capitalization to the transcript. - type: boolean - redact: - description: Redaction removes sensitive information from your transcripts. - type: string - replace: - description: Search for terms or phrases in submitted audio and replaces them. - type: string - search: - description: Search for terms or phrases in submitted audio. - type: string - sentiment: - description: Recognizes the sentiment throughout a transcript or text. - type: boolean - smart_format: - description: Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. - type: boolean - topics: - description: Detect topics throughout a transcript or text. - type: boolean - utt_split: - description: Seconds to wait before detecting a pause between words in submitted audio. - type: number - utterance_end_ms: - description: 'Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets.' - type: boolean - utterances: - description: Segments speech into meaningful semantic units. - type: boolean - vad_events: - description: 'Indicates that speech has started. You''ll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets.' - type: boolean - required: - - audio - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: + raw: + default: false + description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: Penalty for repeated tokens; higher values discourage repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: Controls the randomness of the output; higher values produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: An array of message objects representing the conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. properties: - errors: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: Schema defining the parameters accepted by the function. + properties: properties: - code: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: type: string - message: + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + type: array + requests: + items: + type: object + title: Prompt + properties: + frequency_penalty: + description: Decreases the likelihood of the model repeating the same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: Increases the likelihood of the model introducing new topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: Penalty for repeated tokens; higher values discourage repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: Controls the randomness of the output; higher values produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: An array of message objects representing the conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). type: string required: - - code - - message + - type + - properties type: object - type: array - result: - type: object - success: - type: boolean + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: Schema defining the parameters accepted by the function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + type: array + type: array + guided_json: + description: JSON schema that should be fufilled for the response. + type: object + image: + type: array + description: An array of integers that represent the image data constrained to 8-bit unsigned integer values. Deprecated, use image as a part of messages now. + items: + description: A value between 0 and 255 + type: number + format: binary + audio: + description: Parameters for audio output. Required when modalities includes 'audio'. + properties: + format: + enum: + - wav + - aac + - mp3 + - flac + - opus + - pcm16 + type: string + voice: + type: string + properties: + id: + type: string + required: + - id + required: + - voice + - format + type: object + chat_template_kwargs: + properties: + clear_thinking: + default: false + description: If false, preserves reasoning context between turns. + type: boolean + enable_thinking: + default: true + description: Whether to enable reasoning, enabled by default. + type: boolean + type: object + function_call: + type: string + enum: + - none + - auto + properties: + name: + type: string + required: + - name + logit_bias: + nullable: true + type: object + logprobs: + nullable: true + type: boolean + max_completion_tokens: + nullable: true + type: integer + metadata: + nullable: true + type: object + modalities: + items: + enum: + - text + - audio + type: string + nullable: true + type: array + model: + description: ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). + type: string + 'n': + maximum: 128 + minimum: 1 + nullable: true + type: integer + parallel_tool_calls: + default: true + description: Whether to enable parallel function calling during tool use. + type: boolean + prediction: + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string required: - - errors - - success - - result + - type + - text type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/deepgram/nova-3 model. - tags: - - Workers AI Automatic Speech Recognition - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct: - post: - description: Runs inference on the @cf/deepseek-ai/deepseek-math-7b-instruct model. - operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: + type: + enum: + - content + type: string + required: + - type + - content + type: object + reasoning_effort: + enum: + - low + - medium + - high + nullable: true type: string - x-auditable: true - - in: query - name: tags - schema: + service_tier: + enum: + - auto + - default + - flex + - scale + - priority + nullable: true + type: string + stop: + type: string + items: + type: string + store: + nullable: true + type: boolean + stream_options: + properties: + include_obfuscation: + type: boolean + include_usage: + type: boolean + type: object + tool_choice: + description: Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. type: string - requestBody: - content: - application/json: - schema: + enum: + - none + - auto + - required + properties: + function: + properties: + name: + type: string + required: + - name type: object - title: Prompt + type: + enum: + - function + type: string + custom: properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + name: type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. + required: + - name + type: object + allowed_tools: + properties: + mode: + enum: + - auto + - required + type: string + tools: + items: + type: object + type: array + required: + - mode + - tools + type: object + required: + - type + top_logprobs: + maximum: 20 + minimum: 0 + nullable: true + type: integer + user: + description: A unique identifier representing your end-user, for abuse monitoring. + type: string + web_search_options: + description: Options for the web search tool (when using built-in web search). + properties: + search_context_size: + default: medium + enum: + - low + - medium + - high + type: string + user_location: + properties: + approximate: + properties: + city: + type: string + country: + type: string + region: + type: string + timezone: + type: string + type: object + type: + enum: + - approximate + type: string + required: + - type + - approximate + type: object + type: object + input: + description: Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types + type: string + items: {} + reasoning: + properties: + effort: + description: Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. + enum: + - low + - medium + - high + type: string + summary: + description: A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed. + enum: + - auto + - concise + - detailed + type: string + type: object + stackqlAiTextEmbeddingsRunInput: + type: object + description: Union of request properties across the text_embeddings member models (synthesised by stackql). + properties: + pooling: + default: mean + description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed minLength: 1 type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: + required: + - text + type: object + type: array + contexts: + description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts + minLength: 1 + type: string + truncate_inputs: + default: false + description: When provided with too long context should the model error out or truncate the context to fit? + type: boolean + documents: + type: string + description: A single document string + items: + minLength: 1 + type: string + instruction: + default: Given a web search query, retrieve relevant passages that answer the query + description: Optional instruction for the task + type: string + queries: + type: string + description: A single query string + items: + minLength: 1 + type: string + stackqlAiSpeechToTextRunInput: + type: object + description: Union of request properties across the speech_to_text member models (synthesised by stackql). + properties: + eager_eot_threshold: + description: End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9. + type: string + encoding: + description: Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM. + enum: + - linear16 + type: string + eot_threshold: + default: '0.7' + description: End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9. + type: string + eot_timeout_ms: + default: '5000' + description: A turn will be finished when this much time has passed after speech, regardless of EOT confidence. + type: string + keyterm: + description: Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms. + type: string + mip_opt_out: + default: 'false' + description: Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip + enum: + - 'true' + - 'false' + type: string + sample_rate: + description: Sample rate of the audio stream in Hz. + type: string + tag: + description: Label your requests for the purpose of identification during usage reporting + type: string + audio: + properties: + body: + type: object + contentType: + type: string + required: + - body + - contentType + type: object + channels: + description: The number of channels in the submitted audio + type: number + custom_intent: + description: Custom intents you want the model to detect within your input audio if present + type: string + custom_intent_mode: + description: Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param + enum: + - extended + - strict + type: string + custom_topic: + description: Custom topics you want the model to detect within your input audio or text if present Submit up to 100 + type: string + custom_topic_mode: + description: Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. + enum: + - extended + - strict + type: string + detect_entities: + description: Identifies and extracts key entities from content in submitted audio + type: boolean + detect_language: + description: Identifies the dominant language spoken in submitted audio + type: boolean + diarize: + description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 + type: boolean + dictation: + description: Identify and extract key entities from content in submitted audio + type: boolean + endpointing: + description: Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing + type: string + extra: + description: Arbitrary key-value pairs that are attached to the API response for usage in downstream processing + type: string + filler_words: + description: Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um' + type: boolean + interim_results: + description: 'Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets.' + type: boolean + keywords: + description: Keywords can boost or suppress specialized terminology and brands. + type: string + language: + description: The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available. + type: string + measurements: + description: Spoken measurements will be converted to their corresponding abbreviations. + type: boolean + mode: + description: Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio + enum: + - general + - medical + - finance + type: string + multichannel: + description: Transcribe each audio channel independently. + type: boolean + numerals: + description: Numerals converts numbers from written format to numerical format. + type: boolean + paragraphs: + description: Splits audio into paragraphs to improve transcript readability. + type: boolean + profanity_filter: + description: Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely. + type: boolean + punctuate: + description: Add punctuation and capitalization to the transcript. + type: boolean + redact: + description: Redaction removes sensitive information from your transcripts. + type: string + replace: + description: Search for terms or phrases in submitted audio and replaces them. + type: string + search: + description: Search for terms or phrases in submitted audio. + type: string + sentiment: + description: Recognizes the sentiment throughout a transcript or text. + type: boolean + smart_format: + description: Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. + type: boolean + topics: + description: Detect topics throughout a transcript or text. + type: boolean + utt_split: + description: Seconds to wait before detecting a pause between words in submitted audio. + type: number + utterance_end_ms: + description: 'Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets.' + type: boolean + utterances: + description: Segments speech into meaningful semantic units. + type: boolean + vad_events: + description: 'Indicates that speech has started. You''ll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets.' + type: boolean + beam_size: + default: 5 + description: The number of beams to use in beam search decoding. Higher values may improve accuracy at the cost of speed. + type: integer + compression_ratio_threshold: + default: 2.4 + description: Threshold for filtering out segments with high compression ratio, which often indicate repetitive or hallucinated text. + type: number + condition_on_previous_text: + default: true + description: Whether to condition on previous text during transcription. Setting to false may help prevent hallucination loops. + type: boolean + hallucination_silence_threshold: + description: Optional threshold (in seconds) to skip silent periods that may cause hallucinations. + type: number + initial_prompt: + description: A text prompt to help provide context to the model on the contents of the audio. + type: string + log_prob_threshold: + default: -1 + description: Threshold for filtering out segments with low average log probability, indicating low confidence. + type: number + no_speech_threshold: + default: 0.6 + description: Threshold for detecting no-speech segments. Segments with no-speech probability above this value are skipped. + type: number + prefix: + description: The prefix appended to the beginning of the output of the transcription and can guide the transcription result. + type: string + task: + default: transcribe + description: Supported tasks are 'translate' or 'transcribe'. + type: string + vad_filter: + default: false + description: Preprocess the audio with a voice activity detection model. + type: boolean + stackqlAiTranslationRunInput: + type: object + description: Union of request properties across the translation member models (synthesised by stackql). + properties: + target_language: + default: hin_Deva + description: Target langauge to translate to + enum: + - asm_Beng + - awa_Deva + - ben_Beng + - bho_Deva + - brx_Deva + - doi_Deva + - eng_Latn + - gom_Deva + - gon_Deva + - guj_Gujr + - hin_Deva + - hne_Deva + - kan_Knda + - kas_Arab + - kas_Deva + - kha_Latn + - lus_Latn + - mag_Deva + - mai_Deva + - mal_Mlym + - mar_Deva + - mni_Beng + - mni_Mtei + - npi_Deva + - ory_Orya + - pan_Guru + - san_Deva + - sat_Olck + - snd_Arab + - snd_Deva + - tam_Taml + - tel_Telu + - urd_Arab + - unr_Deva + type: string + text: + description: Input text to translate. Can be a single string or a list of strings. + type: string + items: + type: string + source_lang: + default: en + description: The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified + type: string + target_lang: + description: The language code to translate the text into (e.g., 'es' for Spanish) + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + source_lang: + default: en + description: The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified + type: string + target_lang: + description: The language code to translate the text into (e.g., 'es' for Spanish) + type: string + text: + description: The text to be translated + minLength: 1 + type: string + required: + - text + - target_lang + type: object + type: array + stackqlAiSummarizationRunInput: + type: object + description: Union of request properties across the summarization member models (synthesised by stackql). + properties: + input_text: + description: The text that you want the model to summarize + minLength: 1 + type: string + max_length: + default: 1024 + description: The maximum length of the generated summary in tokens + type: integer + stackqlAiTextToImageRunInput: + type: object + description: Union of request properties across the text_to_image member models (synthesised by stackql). + properties: + prompt: + description: A text description of the image you want to generate. + maxLength: 2048 + minLength: 1 + type: string + steps: + default: 4 + description: The number of diffusion steps; higher values can improve quality but take longer. + maximum: 8 + type: integer + multipart: + properties: + body: + type: object + contentType: + type: string + type: object + guidance: + default: 7.5 + description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: For use with img2img tasks. A base64-encoded string of the input image + type: string + mask: + description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: The number of diffusion steps; higher values can improve quality but take longer + maximum: 20 + type: integer + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + stackqlAiTextToSpeechRunInput: + type: object + description: Union of request properties across the text_to_speech member models (synthesised by stackql). + properties: + bit_rate: + description: The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. + type: number + container: + description: Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. + enum: + - none + - wav + - ogg + type: string + encoding: + description: Encoding of the output audio. + enum: + - linear16 + - flac + - mulaw + - alaw + - mp3 + - opus + - aac + type: string + sample_rate: + description: Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable + type: number + speaker: + default: angus + description: Speaker used to produce the audio. + enum: + - angus + - asteria + - arcas + - orion + - orpheus + - athena + - luna + - zeus + - perseus + - helios + - hera + - stella + type: string + text: + description: The text content to be converted to speech + type: string + lang: + default: en + description: The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified + type: string + prompt: + description: A text description of the audio you want to generate + minLength: 1 + type: string + stackqlAiTextClassificationRunInput: + type: object + description: Union of request properties across the text_classification member models (synthesised by stackql). + properties: + text: + description: The text that you want to classify + minLength: 1 + type: string + stackqlAiRerankingRunInput: + type: object + description: Union of request properties across the reranking member models (synthesised by stackql). + properties: + contexts: + description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: A query you wish to perform against the provided contexts. + minLength: 1 + type: string + top_k: + description: Number of returned results starting with the best score. + minimum: 1 + type: integer + stackqlAiRunInput: + type: object + description: Union of request properties across all Workers AI run models (synthesised by stackql). + properties: + frequency_penalty: + description: Decreases the likelihood of the model repeating the same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + type: string + max_tokens: + default: 2000 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: Increases the likelihood of the model introducing new topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: Penalty for repeated tokens; higher values discourage repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: Controls the randomness of the output; higher values produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: An array of message objects representing the conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: properties: - json_schema: {} + text: + description: Text content + type: string type: - enum: - - json_object - - json_schema + description: Type of the content (text) type: string - title: JSON Mode type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code + role: + description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: Schema defining the parameters accepted by the function. properties: - content: - type: string - description: The content of the message as a string. + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). type: string required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: + - type + - properties type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + type: array + requests: + items: + type: object + title: Prompt + properties: + frequency_penalty: + description: Decreases the likelihood of the model repeating the same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: Increases the likelihood of the model introducing new topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: Penalty for repeated tokens; higher values discourage repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: Controls the randomness of the output; higher values produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: An array of message objects representing the conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string type: - description: The type of the parameters object (usually 'object'). + description: Type of the content (text) type: string - required: - - type - - properties type: object - function: - description: Details of the function tool. + role: + description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object + description: Definitions of each parameter. + type: object required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. properties: - code: + description: + description: A brief description of what the function does. type: string - message: + name: + description: The name of the function. type: string + parameters: + description: Schema defining the parameters accepted by the function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: The type of the parameters object (usually 'object'). + type: string + required: + - type + - properties + type: object required: - - code - - message + - name + - description + - parameters type: object - type: array - result: - type: object - success: - type: boolean + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + type: array + type: array + guided_json: + description: JSON schema that should be fufilled for the response. + type: object + image: + type: array + description: An array of integers that represent the image data constrained to 8-bit unsigned integer values. Deprecated, use image as a part of messages now. + items: + description: A value between 0 and 255 + type: number + format: binary + audio: + description: Parameters for audio output. Required when modalities includes 'audio'. + properties: + format: + enum: + - wav + - aac + - mp3 + - flac + - opus + - pcm16 + type: string + voice: + type: string + properties: + id: + type: string + required: + - id + required: + - voice + - format + type: object + chat_template_kwargs: + properties: + clear_thinking: + default: false + description: If false, preserves reasoning context between turns. + type: boolean + enable_thinking: + default: true + description: Whether to enable reasoning, enabled by default. + type: boolean + type: object + function_call: + type: string + enum: + - none + - auto + properties: + name: + type: string + required: + - name + logit_bias: + nullable: true + type: object + logprobs: + nullable: true + type: boolean + max_completion_tokens: + nullable: true + type: integer + metadata: + nullable: true + type: object + modalities: + items: + enum: + - text + - audio + type: string + nullable: true + type: array + model: + description: ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). + type: string + 'n': + maximum: 128 + minimum: 1 + nullable: true + type: integer + parallel_tool_calls: + default: true + description: Whether to enable parallel function calling during tool use. + type: boolean + prediction: + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string required: - - errors - - success - - result + - type + - text type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/deepseek-ai/deepseek-math-7b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-r1-distill-qwen-32b: - post: - description: Runs inference on the @cf/deepseek-ai/deepseek-r1-distill-qwen-32b model. - operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-r1-distill-qwen-32b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: + type: + enum: + - content + type: string + required: + - type + - content + type: object + reasoning_effort: + enum: + - low + - medium + - high + nullable: true type: string - x-auditable: true - - in: query - name: tags - schema: + service_tier: + enum: + - auto + - default + - flex + - scale + - priority + nullable: true + type: string + stop: + type: string + items: + type: string + store: + nullable: true + type: boolean + stream_options: + properties: + include_obfuscation: + type: boolean + include_usage: + type: boolean + type: object + tool_choice: + description: Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. type: string - requestBody: - content: - application/json: - schema: + enum: + - none + - auto + - required + properties: + function: + properties: + name: + type: string + required: + - name type: object - title: Prompt + type: + enum: + - function + type: string + custom: properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. + name: type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 + required: + - name + type: object + allowed_tools: + properties: + mode: + enum: + - auto + - required type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: + tools: + items: + type: object + type: array + required: + - mode + - tools + type: object + required: + - type + top_logprobs: + maximum: 20 + minimum: 0 + nullable: true + type: integer + user: + description: A unique identifier representing your end-user, for abuse monitoring. + type: string + web_search_options: + description: Options for the web search tool (when using built-in web search). + properties: + search_context_size: + default: medium + enum: + - low + - medium + - high + type: string + user_location: + properties: + approximate: properties: - json_schema: {} - type: - enum: - - json_object - - json_schema + city: + type: string + country: + type: string + region: + type: string + timezone: type: string - title: JSON Mode type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/deepseek-ai/deepseek-r1-distill-qwen-32b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2: - post: - description: Runs inference on the @cf/defog/sqlcoder-7b-2 model. - operationId: workers-ai-post-run-cf-defog-sqlcoder-7b-2 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: + type: + enum: + - approximate + type: string + required: + - type + - approximate + type: object + type: object + input: + description: Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types + type: string + items: {} + reasoning: + properties: + effort: + description: Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. + enum: + - low + - medium + - high + type: string + summary: + description: A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed. + enum: + - auto + - concise + - detailed + type: string + type: object + pooling: + default: mean + description: The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + contexts: + description: List of provided contexts. Note that the index in this array is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts + minLength: 1 type: string - - in: query - name: queueRequest - schema: + truncate_inputs: + default: false + description: When provided with too long context should the model error out or truncate the context to fit? + type: boolean + documents: + type: string + description: A single document string + items: + minLength: 1 + type: string + instruction: + default: Given a web search query, retrieve relevant passages that answer the query + description: Optional instruction for the task + type: string + queries: + type: string + description: A single query string + items: + minLength: 1 + type: string + eager_eot_threshold: + description: End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9. + type: string + encoding: + description: Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM. + enum: + - linear16 type: string - x-auditable: true - - in: query - name: tags - schema: + eot_threshold: + default: '0.7' + description: End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9. type: string - requestBody: - content: - application/json: - schema: + eot_timeout_ms: + default: '5000' + description: A turn will be finished when this much time has passed after speech, regardless of EOT confidence. + type: string + keyterm: + description: Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms. + type: string + mip_opt_out: + default: 'false' + description: Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip + enum: + - 'true' + - 'false' + type: string + sample_rate: + description: Sample rate of the audio stream in Hz. + type: string + tag: + description: Label your requests for the purpose of identification during usage reporting + type: string + channels: + description: The number of channels in the submitted audio + type: number + custom_intent: + description: Custom intents you want the model to detect within your input audio if present + type: string + custom_intent_mode: + description: Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param + enum: + - extended + - strict + type: string + custom_topic: + description: Custom topics you want the model to detect within your input audio or text if present Submit up to 100 + type: string + custom_topic_mode: + description: Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. + enum: + - extended + - strict + type: string + detect_entities: + description: Identifies and extracts key entities from content in submitted audio + type: boolean + detect_language: + description: Identifies the dominant language spoken in submitted audio + type: boolean + diarize: + description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 + type: boolean + dictation: + description: Identify and extract key entities from content in submitted audio + type: boolean + endpointing: + description: Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing + type: string + extra: + description: Arbitrary key-value pairs that are attached to the API response for usage in downstream processing + type: string + filler_words: + description: Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um' + type: boolean + interim_results: + description: 'Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets.' + type: boolean + keywords: + description: Keywords can boost or suppress specialized terminology and brands. + type: string + language: + description: The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available. + type: string + measurements: + description: Spoken measurements will be converted to their corresponding abbreviations. + type: boolean + mode: + description: Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio + enum: + - general + - medical + - finance + type: string + multichannel: + description: Transcribe each audio channel independently. + type: boolean + numerals: + description: Numerals converts numbers from written format to numerical format. + type: boolean + paragraphs: + description: Splits audio into paragraphs to improve transcript readability. + type: boolean + profanity_filter: + description: Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely. + type: boolean + punctuate: + description: Add punctuation and capitalization to the transcript. + type: boolean + redact: + description: Redaction removes sensitive information from your transcripts. + type: string + replace: + description: Search for terms or phrases in submitted audio and replaces them. + type: string + search: + description: Search for terms or phrases in submitted audio. + type: string + sentiment: + description: Recognizes the sentiment throughout a transcript or text. + type: boolean + smart_format: + description: Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. + type: boolean + topics: + description: Detect topics throughout a transcript or text. + type: boolean + utt_split: + description: Seconds to wait before detecting a pause between words in submitted audio. + type: number + utterance_end_ms: + description: 'Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets.' + type: boolean + utterances: + description: Segments speech into meaningful semantic units. + type: boolean + vad_events: + description: 'Indicates that speech has started. You''ll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets.' + type: boolean + beam_size: + default: 5 + description: The number of beams to use in beam search decoding. Higher values may improve accuracy at the cost of speed. + type: integer + compression_ratio_threshold: + default: 2.4 + description: Threshold for filtering out segments with high compression ratio, which often indicate repetitive or hallucinated text. + type: number + condition_on_previous_text: + default: true + description: Whether to condition on previous text during transcription. Setting to false may help prevent hallucination loops. + type: boolean + hallucination_silence_threshold: + description: Optional threshold (in seconds) to skip silent periods that may cause hallucinations. + type: number + initial_prompt: + description: A text prompt to help provide context to the model on the contents of the audio. + type: string + log_prob_threshold: + default: -1 + description: Threshold for filtering out segments with low average log probability, indicating low confidence. + type: number + no_speech_threshold: + default: 0.6 + description: Threshold for detecting no-speech segments. Segments with no-speech probability above this value are skipped. + type: number + prefix: + description: The prefix appended to the beginning of the output of the transcription and can guide the transcription result. + type: string + task: + default: transcribe + description: Supported tasks are 'translate' or 'transcribe'. + type: string + vad_filter: + default: false + description: Preprocess the audio with a voice activity detection model. + type: boolean + target_language: + default: hin_Deva + description: Target langauge to translate to + enum: + - asm_Beng + - awa_Deva + - ben_Beng + - bho_Deva + - brx_Deva + - doi_Deva + - eng_Latn + - gom_Deva + - gon_Deva + - guj_Gujr + - hin_Deva + - hne_Deva + - kan_Knda + - kas_Arab + - kas_Deva + - kha_Latn + - lus_Latn + - mag_Deva + - mai_Deva + - mal_Mlym + - mar_Deva + - mni_Beng + - mni_Mtei + - npi_Deva + - ory_Orya + - pan_Guru + - san_Deva + - sat_Olck + - snd_Arab + - snd_Deva + - tam_Taml + - tel_Telu + - urd_Arab + - unr_Deva + type: string + source_lang: + default: en + description: The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified + type: string + target_lang: + description: The language code to translate the text into (e.g., 'es' for Spanish) + type: string + input_text: + description: The text that you want the model to summarize + minLength: 1 + type: string + max_length: + default: 1024 + description: The maximum length of the generated summary in tokens + type: integer + steps: + default: 4 + description: The number of diffusion steps; higher values can improve quality but take longer. + maximum: 8 + type: integer + multipart: + properties: + body: type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/defog/sqlcoder-7b-2 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn: - post: - description: Runs inference on the @cf/facebook/bart-large-cnn model. - operationId: workers-ai-post-run-cf-facebook-bart-large-cnn - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: + contentType: + type: string + type: object + guidance: + default: 7.5 + description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image_b64: + description: For use with img2img tasks. A base64-encoded string of the input image + type: string + mask: + description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: The number of diffusion steps; higher values can improve quality but take longer + maximum: 20 + type: integer + strength: + default: 1 + description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + bit_rate: + description: The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. + type: number + container: + description: Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. + enum: + - none + - wav + - ogg type: string - x-auditable: true - - in: query - name: tags - schema: + speaker: + default: angus + description: Speaker used to produce the audio. + enum: + - angus + - asteria + - arcas + - orion + - orpheus + - athena + - luna + - zeus + - perseus + - helios + - hera + - stella + type: string + lang: + default: en + description: The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified type: string - requestBody: - content: - application/json: - schema: - properties: - input_text: - description: The text that you want the model to summarize - minLength: 1 - type: string - max_length: - default: 1024 - description: The maximum length of the generated summary in tokens - type: integer - required: - - input_text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/facebook/bart-large-cnn model. - tags: - - Workers AI Summarization - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/facebook/nonomni-bart-large-cnn: - post: - description: Runs inference on the @cf/facebook/nonomni-bart-large-cnn model. - operationId: workers-ai-post-run-cf-facebook-nonomni-bart-large-cnn - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - input_text: - description: The text that you want the model to summarize - minLength: 1 - type: string - max_length: - default: 1024 - description: The maximum length of the generated summary in tokens - type: integer - required: - - input_text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/facebook/nonomni-bart-large-cnn model. - tags: - - Workers AI Summarization - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/facebook/nonomni-detr-resnet-50: - post: - description: Runs inference on the @cf/facebook/nonomni-detr-resnet-50 model. - operationId: workers-ai-post-run-cf-facebook-nonomni-detr-resnet-50 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/octet-stream: - schema: - format: binary - type: string - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/facebook/nonomni-detr-resnet-50 model. - tags: - - Workers AI Object Detection - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/fblgit/una-cybertron-7b-v2-bf16: - post: - description: Runs inference on the @cf/fblgit/una-cybertron-7b-v2-bf16 model. - operationId: workers-ai-post-run-cf-fblgit-una-cybertron-7b-v2-bf16 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/fblgit/una-cybertron-7b-v2-bf16 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/google/embeddinggemma-300m: - post: - description: Runs inference on the @cf/google/embeddinggemma-300m model. - operationId: workers-ai-post-run-cf-google-embeddinggemma-300m - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - text: - type: string - description: The text to embed - items: - description: The text to embed - minLength: 1 - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/google/embeddinggemma-300m model. - tags: - - Workers AI Text Embeddings - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/google/gemma-2b-it-lora: - post: - description: Runs inference on the @cf/google/gemma-2b-it-lora model. - operationId: workers-ai-post-run-cf-google-gemma-2b-it-lora - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/google/gemma-2b-it-lora model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/google/gemma-3-12b-it: - post: - description: Runs inference on the @cf/google/gemma-3-12b-it model. - operationId: workers-ai-post-run-cf-google-gemma-3-12b-it - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - guided_json: - description: JSON schema that should be fufilled for the response. - type: object - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/google/gemma-3-12b-it model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/google/gemma-7b-it-lora: - post: - description: Runs inference on the @cf/google/gemma-7b-it-lora model. - operationId: workers-ai-post-run-cf-google-gemma-7b-it-lora - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/google/gemma-7b-it-lora model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/google/nonomni-embeddinggemma-300m: - post: - description: Runs inference on the @cf/google/nonomni-embeddinggemma-300m model. - operationId: workers-ai-post-run-cf-google-nonomni-embeddinggemma-300m - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - text: - description: Input text to embed. Can be a single string or a list of strings. - type: string - items: - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/google/nonomni-embeddinggemma-300m model. - tags: - - Workers AI Text Embeddings - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/huggingface/distilbert-sst-2-int8: - post: - description: Runs inference on the @cf/huggingface/distilbert-sst-2-int8 model. - operationId: workers-ai-post-run-cf-huggingface-distilbert-sst-2-int8 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - text: - description: The text that you want to classify - minLength: 1 - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/huggingface/distilbert-sst-2-int8 model. - tags: - - Workers AI Text Classification - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/huggingface/nonomni-distilbert-sst-2-int8: - post: - description: Runs inference on the @cf/huggingface/nonomni-distilbert-sst-2-int8 model. - operationId: workers-ai-post-run-cf-huggingface-nonomni-distilbert-sst-2-int8 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - text: - description: The text that you want to classify - minLength: 1 - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/huggingface/nonomni-distilbert-sst-2-int8 model. - tags: - - Workers AI Text Classification - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/ibm-granite/granite-4.0-h-micro: - post: - description: Runs inference on the @cf/ibm-granite/granite-4.0-h-micro model. - operationId: workers-ai-post-run-cf-ibm-granite-granite-4-0-h-micro - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/ibm-granite/granite-4.0-h-micro model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/leonardo/lucid-origin: - post: - description: Runs inference on the @cf/leonardo/lucid-origin model. - operationId: workers-ai-post-run-cf-leonardo-lucid-origin - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - guidance: - default: 4.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - maximum: 10 - minimum: 0 - type: number - height: - default: 1120 - description: The height of the generated image in pixels - maximum: 2500 - minimum: 0 - type: integer - num_steps: - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 40 - minimum: 1 - type: integer - prompt: - description: A text description of the image you want to generate. - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - minimum: 0 - type: integer - steps: - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 40 - minimum: 1 - type: integer - width: - default: 1120 - description: The width of the generated image in pixels - maximum: 2500 - minimum: 0 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/leonardo/lucid-origin model. - tags: - - Workers AI Text To Image - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/leonardo/phoenix-1.0: - post: - description: Runs inference on the @cf/leonardo/phoenix-1.0 model. - operationId: workers-ai-post-run-cf-leonardo-phoenix-1-0 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - guidance: - default: 2 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - maximum: 10 - minimum: 2 - type: number - height: - default: 1024 - description: The height of the generated image in pixels - maximum: 2048 - minimum: 0 - type: integer - negative_prompt: - description: Specify what to exclude from the generated images - minLength: 1 - type: string - num_steps: - default: 25 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 50 - minimum: 1 - type: integer - prompt: - description: A text description of the image you want to generate. - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - minimum: 0 - type: integer - width: - default: 1024 - description: The width of the generated image in pixels - maximum: 2048 - minimum: 0 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - image/jpeg: - schema: - format: binary - type: string - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/leonardo/phoenix-1.0 model. - tags: - - Workers AI Text To Image - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/lykon/dreamshaper-8-lcm: - post: - description: Runs inference on the @cf/lykon/dreamshaper-8-lcm model. - operationId: workers-ai-post-run-cf-lykon-dreamshaper-8-lcm - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - guidance: - default: 7.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - type: number - height: - description: The height of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - image: - description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - image_b64: - description: For use with img2img tasks. A base64-encoded string of the input image - type: string - mask: - description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - negative_prompt: - description: Text describing elements to avoid in the generated image - type: string - num_steps: - default: 20 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 20 - type: integer - prompt: - description: A text description of the image you want to generate - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - type: integer - strength: - default: 1 - description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - type: number - width: - description: The width of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - image/png: - schema: - format: binary - type: string - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/lykon/dreamshaper-8-lcm model. - tags: - - Workers AI Text To Image - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta-llama/llama-2-7b-chat-hf-lora: - post: - description: Runs inference on the @cf/meta-llama/llama-2-7b-chat-hf-lora model. - operationId: workers-ai-post-run-cf-meta-llama-llama-2-7b-chat-hf-lora - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta-llama/llama-2-7b-chat-hf-lora model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-fp16: - post: - description: Runs inference on the @cf/meta/llama-2-7b-chat-fp16 model. - operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-fp16 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-2-7b-chat-fp16 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-int8: - post: - description: Runs inference on the @cf/meta/llama-2-7b-chat-int8 model. - operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-int8 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-2-7b-chat-int8 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct: - post: - description: Runs inference on the @cf/meta/llama-3-8b-instruct model. - operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3-8b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct-awq: - post: - description: Runs inference on the @cf/meta/llama-3-8b-instruct-awq model. - operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3-8b-instruct-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-70b-instruct-fp8-fast: - post: - description: Runs inference on the @cf/meta/llama-3.1-70b-instruct-fp8-fast model. - operationId: workers-ai-post-run-cf-meta-llama-3-1-70b-instruct-fp8-fast - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.1-70b-instruct-fp8-fast model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-awq: - post: - description: Runs inference on the @cf/meta/llama-3.1-8b-instruct-awq model. - operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.1-8b-instruct-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8: - post: - description: Runs inference on the @cf/meta/llama-3.1-8b-instruct-fp8 model. - operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.1-8b-instruct-fp8 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8-fast: - post: - description: Runs inference on the @cf/meta/llama-3.1-8b-instruct-fp8-fast model. - operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8-fast - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.1-8b-instruct-fp8-fast model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.2-11b-vision-instruct: - post: - description: Runs inference on the @cf/meta/llama-3.2-11b-vision-instruct model. - operationId: workers-ai-post-run-cf-meta-llama-3-2-11b-vision-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - image: - type: array - description: An array of integers that represent the image data constrained to 8-bit unsigned integer values. Deprecated, use image as a part of messages now. - items: - description: A value between 0 and 255 - type: number - format: binary - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - maxLength: 131072 - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - type: object - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - tool_call_id: - description: The tool call id. If you don't know what to put here you can fall back to 000000001 - type: string - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.2-11b-vision-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.2-1b-instruct: - post: - description: Runs inference on the @cf/meta/llama-3.2-1b-instruct model. - operationId: workers-ai-post-run-cf-meta-llama-3-2-1b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.2-1b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.2-3b-instruct: - post: - description: Runs inference on the @cf/meta/llama-3.2-3b-instruct model. - operationId: workers-ai-post-run-cf-meta-llama-3-2-3b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.2-3b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-3.3-70b-instruct-fp8-fast: - post: - description: Runs inference on the @cf/meta/llama-3.3-70b-instruct-fp8-fast model. - operationId: workers-ai-post-run-cf-meta-llama-3-3-70b-instruct-fp8-fast - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - requests: - items: - properties: - external_reference: - description: User-supplied reference. This field will be present in the response as well it can be used to reference the request and response. It's NOT validated to be unique. - type: string - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: Prompt for the text generation model - minLength: 1 - type: string - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - type: object - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-3.3-70b-instruct-fp8-fast model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-4-scout-17b-16e-instruct: - post: - description: Runs inference on the @cf/meta/llama-4-scout-17b-16e-instruct model. - operationId: workers-ai-post-run-cf-meta-llama-4-scout-17b-16e-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - guided_json: - description: JSON schema that should be fulfilled for the response. - type: object - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.15 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - type: object - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - tool_call_id: - description: The tool call id. If you don't know what to put here you can fall back to 000000001 - type: string - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - requests: - items: - type: object - title: Prompt_Inner - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - guided_json: - description: JSON schema that should be fulfilled for the response. - type: object - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.15 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - type: object - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - tool_call_id: - description: The tool call id. If you don't know what to put here you can fall back to 000000001 - type: string - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-4-scout-17b-16e-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/llama-guard-3-8b: - post: - description: Runs inference on the @cf/meta/llama-guard-3-8b model. - operationId: workers-ai-post-run-cf-meta-llama-guard-3-8b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - description: The content of the message as a string. - type: string - role: - description: The role of the message sender must alternate between 'user' and 'assistant'. - enum: - - user - - assistant - type: string - required: - - role - - content - type: object - type: array - response_format: - description: Dictate the output format of the generated response. - properties: - type: - description: Set to json_object to process and output generated text as JSON. - type: string - type: object - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - required: - - messages - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/llama-guard-3-8b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b: - post: - description: Runs inference on the @cf/meta/m2m100-1.2b model. - operationId: workers-ai-post-run-cf-meta-m2m100-1-2b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - source_lang: - default: en - description: The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified - type: string - target_lang: - description: The language code to translate the text into (e.g., 'es' for Spanish) - type: string - text: - description: The text to be translated - minLength: 1 - type: string - requests: - description: Batch of the embeddings requests to run using async-queue - items: - properties: - source_lang: - default: en - description: The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified - type: string - target_lang: - description: The language code to translate the text into (e.g., 'es' for Spanish) - type: string - text: - description: The text to be translated - minLength: 1 - type: string - required: - - text - - target_lang - type: object - type: array - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/meta/m2m100-1.2b model. - tags: - - Workers AI Translation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/microsoft/nonomni-resnet-50: - post: - description: Runs inference on the @cf/microsoft/nonomni-resnet-50 model. - operationId: workers-ai-post-run-cf-microsoft-nonomni-resnet-50 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/octet-stream: - schema: - format: binary - type: string - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/microsoft/nonomni-resnet-50 model. - tags: - - Workers AI Image Classification - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/microsoft/phi-2: - post: - description: Runs inference on the @cf/microsoft/phi-2 model. - operationId: workers-ai-post-run-cf-microsoft-phi-2 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/microsoft/phi-2 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/microsoft/resnet-50: - post: - description: Runs inference on the @cf/microsoft/resnet-50 model. - operationId: workers-ai-post-run-cf-microsoft-resnet-50 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/octet-stream: - schema: - format: binary - type: string - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/microsoft/resnet-50 model. - tags: - - Workers AI Image Classification - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1: - post: - description: Runs inference on the @cf/mistral/mistral-7b-instruct-v0.1 model. - operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/mistral/mistral-7b-instruct-v0.1 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.2-lora: - post: - description: Runs inference on the @cf/mistral/mistral-7b-instruct-v0.2-lora model. - operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-2-lora - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/mistral/mistral-7b-instruct-v0.2-lora model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/mistralai/mistral-small-3.1-24b-instruct: - post: - description: Runs inference on the @cf/mistralai/mistral-small-3.1-24b-instruct model. - operationId: workers-ai-post-run-cf-mistralai-mistral-small-3-1-24b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - guided_json: - description: JSON schema that should be fulfilled for the response. - type: object - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.15 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - type: object - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - tool_call_id: - description: The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001 - type: string - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/mistralai/mistral-small-3.1-24b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/moonshotai/kimi-k2.5: - post: - description: Runs inference on the @cf/moonshotai/kimi-k2.5 model. - operationId: workers-ai-post-run-cf-moonshotai-kimi-k2-5 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - audio: - description: Parameters for audio output. Required when modalities includes 'audio'. - properties: - format: - enum: - - wav - - aac - - mp3 - - flac - - opus - - pcm16 - type: string - voice: - type: string - properties: - id: - type: string - required: - - id - required: - - voice - - format - type: object - chat_template_kwargs: - properties: - clear_thinking: - default: false - description: If false, preserves reasoning context between turns. - type: boolean - enable_thinking: - default: true - description: Whether to enable reasoning, enabled by default. - type: boolean - type: object - frequency_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - function_call: - type: string - enum: - - none - - auto - properties: - name: - type: string - required: - - name - functions: - items: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - maxItems: 128 - minItems: 1 - type: array - logit_bias: - nullable: true - type: object - logprobs: - nullable: true - type: boolean - max_completion_tokens: - nullable: true - type: integer - max_tokens: - nullable: true - type: integer - metadata: - nullable: true - type: object - modalities: - items: - enum: - - text - - audio - type: string - nullable: true - type: array - model: - description: ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - type: string - 'n': - maximum: 128 - minimum: 1 - nullable: true - type: integer - parallel_tool_calls: - default: true - description: Whether to enable parallel function calling during tool use. - type: boolean - prediction: - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - type: - enum: - - content - type: string - required: - - type - - content - type: object - presence_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - reasoning_effort: - enum: - - low - - medium - - high - nullable: true - type: string - response_format: - description: Specifies the format the model must output. - type: object - properties: - type: - enum: - - text - type: string - json_schema: - properties: - description: - type: string - name: - type: string - schema: - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - required: - - type - seed: - nullable: true - type: integer - service_tier: - enum: - - auto - - default - - flex - - scale - - priority - nullable: true - type: string - stop: - type: string - items: - type: string - store: - nullable: true - type: boolean - stream: - nullable: true - type: boolean - stream_options: - properties: - include_obfuscation: - type: boolean - include_usage: - type: boolean - type: object - temperature: - maximum: 2 - minimum: 0 - nullable: true - type: number - tool_choice: - description: Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - type: string - enum: - - none - - auto - - required - properties: - function: - properties: - name: - type: string - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - name: - type: string - required: - - name - type: object - allowed_tools: - properties: - mode: - enum: - - auto - - required - type: string - tools: - items: - type: object - type: array - required: - - mode - - tools - type: object - required: - - type - tools: - description: A list of tools the model may call. - items: - type: object - properties: - function: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - description: - type: string - format: - type: object - properties: - type: - enum: - - text - type: string - grammar: - properties: - definition: - type: string - syntax: - enum: - - lark - - regex - type: string - required: - - definition - - syntax - type: object - required: - - type - name: - type: string - required: - - name - type: object - required: - - type - type: array - top_logprobs: - maximum: 20 - minimum: 0 - nullable: true - type: integer - top_p: - maximum: 1 - minimum: 0 - nullable: true - type: number - user: - description: A unique identifier representing your end-user, for abuse monitoring. - type: string - web_search_options: - description: Options for the web search tool (when using built-in web search). - properties: - search_context_size: - default: medium - enum: - - low - - medium - - high - type: string - user_location: - properties: - approximate: - properties: - city: - type: string - country: - type: string - region: - type: string - timezone: - type: string - type: object - type: - enum: - - approximate - type: string - required: - - type - - approximate - type: object - type: object - messages: - description: A list of messages comprising the conversation so far. - items: - type: object - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - name: - type: string - role: - enum: - - developer - type: string - audio: - properties: - id: - type: string - required: - - id - type: object - function_call: - properties: - arguments: - type: string - name: - type: string - required: - - name - - arguments - type: object - refusal: - nullable: true - type: string - tool_calls: - items: - type: object - properties: - function: - properties: - arguments: - description: JSON-encoded arguments string. - type: string - name: - type: string - required: - - name - - arguments - type: object - id: - type: string - type: - enum: - - function - type: string - custom: - properties: - input: - type: string - name: - type: string - required: - - name - - input - type: object - required: - - id - - type - type: array - tool_call_id: - type: string - required: - - role - minItems: 1 - type: array - requests: - items: - type: object - title: Prompt - properties: - audio: - description: Parameters for audio output. Required when modalities includes 'audio'. - properties: - format: - enum: - - wav - - aac - - mp3 - - flac - - opus - - pcm16 - type: string - voice: - type: string - properties: - id: - type: string - required: - - id - required: - - voice - - format - type: object - chat_template_kwargs: - properties: - clear_thinking: - default: false - description: If false, preserves reasoning context between turns. - type: boolean - enable_thinking: - default: true - description: Whether to enable reasoning, enabled by default. - type: boolean - type: object - frequency_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - function_call: - type: string - enum: - - none - - auto - properties: - name: - type: string - required: - - name - functions: - items: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - maxItems: 128 - minItems: 1 - type: array - logit_bias: - nullable: true - type: object - logprobs: - nullable: true - type: boolean - max_completion_tokens: - nullable: true - type: integer - max_tokens: - nullable: true - type: integer - metadata: - nullable: true - type: object - modalities: - items: - enum: - - text - - audio - type: string - nullable: true - type: array - model: - description: ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - type: string - 'n': - maximum: 128 - minimum: 1 - nullable: true - type: integer - parallel_tool_calls: - default: true - description: Whether to enable parallel function calling during tool use. - type: boolean - prediction: - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - type: - enum: - - content - type: string - required: - - type - - content - type: object - presence_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - reasoning_effort: - enum: - - low - - medium - - high - nullable: true - type: string - response_format: - description: Specifies the format the model must output. - type: object - properties: - type: - enum: - - text - type: string - json_schema: - properties: - description: - type: string - name: - type: string - schema: - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - required: - - type - seed: - nullable: true - type: integer - service_tier: - enum: - - auto - - default - - flex - - scale - - priority - nullable: true - type: string - stop: - type: string - items: - type: string - store: - nullable: true - type: boolean - stream: - nullable: true - type: boolean - stream_options: - properties: - include_obfuscation: - type: boolean - include_usage: - type: boolean - type: object - temperature: - maximum: 2 - minimum: 0 - nullable: true - type: number - tool_choice: - description: Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - type: string - enum: - - none - - auto - - required - properties: - function: - properties: - name: - type: string - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - name: - type: string - required: - - name - type: object - allowed_tools: - properties: - mode: - enum: - - auto - - required - type: string - tools: - items: - type: object - type: array - required: - - mode - - tools - type: object - required: - - type - tools: - description: A list of tools the model may call. - items: - type: object - properties: - function: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - description: - type: string - format: - type: object - properties: - type: - enum: - - text - type: string - grammar: - properties: - definition: - type: string - syntax: - enum: - - lark - - regex - type: string - required: - - definition - - syntax - type: object - required: - - type - name: - type: string - required: - - name - type: object - required: - - type - type: array - top_logprobs: - maximum: 20 - minimum: 0 - nullable: true - type: integer - top_p: - maximum: 1 - minimum: 0 - nullable: true - type: number - user: - description: A unique identifier representing your end-user, for abuse monitoring. - type: string - web_search_options: - description: Options for the web search tool (when using built-in web search). - properties: - search_context_size: - default: medium - enum: - - low - - medium - - high - type: string - user_location: - properties: - approximate: - properties: - city: - type: string - country: - type: string - region: - type: string - timezone: - type: string - type: object - type: - enum: - - approximate - type: string - required: - - type - - approximate - type: object - type: object - messages: - description: A list of messages comprising the conversation so far. - items: - type: object - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - name: - type: string - role: - enum: - - developer - type: string - audio: - properties: - id: - type: string - required: - - id - type: object - function_call: - properties: - arguments: - type: string - name: - type: string - required: - - name - - arguments - type: object - refusal: - nullable: true - type: string - tool_calls: - items: - type: object - properties: - function: - properties: - arguments: - description: JSON-encoded arguments string. - type: string - name: - type: string - required: - - name - - arguments - type: object - id: - type: string - type: - enum: - - function - type: string - custom: - properties: - input: - type: string - name: - type: string - required: - - name - - input - type: object - required: - - id - - type - type: array - tool_call_id: - type: string - required: - - role - minItems: 1 - type: array - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/moonshotai/kimi-k2.5 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/myshell-ai/melotts: - post: - description: Runs inference on the @cf/myshell-ai/melotts model. - operationId: workers-ai-post-run-cf-myshell-ai-melotts - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - lang: - default: en - description: The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified - type: string - prompt: - description: A text description of the audio you want to generate - minLength: 1 - type: string - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/myshell-ai/melotts model. - tags: - - Workers AI Text To Speech - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/nvidia/nemotron-3-120b-a12b: - post: - description: Runs inference on the @cf/nvidia/nemotron-3-120b-a12b model. - operationId: workers-ai-post-run-cf-nvidia-nemotron-3-120b-a12b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - audio: - description: Parameters for audio output. Required when modalities includes 'audio'. - properties: - format: - enum: - - wav - - aac - - mp3 - - flac - - opus - - pcm16 - type: string - voice: - type: string - properties: - id: - type: string - required: - - id - required: - - voice - - format - type: object - chat_template_kwargs: - properties: - clear_thinking: - default: false - description: If false, preserves reasoning context between turns. - type: boolean - enable_thinking: - default: true - description: Whether to enable reasoning, enabled by default. - type: boolean - type: object - frequency_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - function_call: - type: string - enum: - - none - - auto - properties: - name: - type: string - required: - - name - functions: - items: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - maxItems: 128 - minItems: 1 - type: array - logit_bias: - nullable: true - type: object - logprobs: - nullable: true - type: boolean - max_completion_tokens: - nullable: true - type: integer - max_tokens: - nullable: true - type: integer - metadata: - nullable: true - type: object - modalities: - items: - enum: - - text - - audio - type: string - nullable: true - type: array - model: - description: ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - type: string - 'n': - maximum: 128 - minimum: 1 - nullable: true - type: integer - parallel_tool_calls: - default: true - description: Whether to enable parallel function calling during tool use. - type: boolean - prediction: - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - type: - enum: - - content - type: string - required: - - type - - content - type: object - presence_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - reasoning_effort: - enum: - - low - - medium - - high - nullable: true - type: string - response_format: - description: Specifies the format the model must output. - type: object - properties: - type: - enum: - - text - type: string - json_schema: - properties: - description: - type: string - name: - type: string - schema: - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - required: - - type - seed: - nullable: true - type: integer - service_tier: - enum: - - auto - - default - - flex - - scale - - priority - nullable: true - type: string - stop: - type: string - items: - type: string - store: - nullable: true - type: boolean - stream: - nullable: true - type: boolean - stream_options: - properties: - include_obfuscation: - type: boolean - include_usage: - type: boolean - type: object - temperature: - maximum: 2 - minimum: 0 - nullable: true - type: number - tool_choice: - description: Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - type: string - enum: - - none - - auto - - required - properties: - function: - properties: - name: - type: string - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - name: - type: string - required: - - name - type: object - allowed_tools: - properties: - mode: - enum: - - auto - - required - type: string - tools: - items: - type: object - type: array - required: - - mode - - tools - type: object - required: - - type - tools: - description: A list of tools the model may call. - items: - type: object - properties: - function: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - description: - type: string - format: - type: object - properties: - type: - enum: - - text - type: string - grammar: - properties: - definition: - type: string - syntax: - enum: - - lark - - regex - type: string - required: - - definition - - syntax - type: object - required: - - type - name: - type: string - required: - - name - type: object - required: - - type - type: array - top_logprobs: - maximum: 20 - minimum: 0 - nullable: true - type: integer - top_p: - maximum: 1 - minimum: 0 - nullable: true - type: number - user: - description: A unique identifier representing your end-user, for abuse monitoring. - type: string - web_search_options: - description: Options for the web search tool (when using built-in web search). - properties: - search_context_size: - default: medium - enum: - - low - - medium - - high - type: string - user_location: - properties: - approximate: - properties: - city: - type: string - country: - type: string - region: - type: string - timezone: - type: string - type: object - type: - enum: - - approximate - type: string - required: - - type - - approximate - type: object - type: object - messages: - description: A list of messages comprising the conversation so far. - items: - type: object - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - name: - type: string - role: - enum: - - developer - type: string - audio: - properties: - id: - type: string - required: - - id - type: object - function_call: - properties: - arguments: - type: string - name: - type: string - required: - - name - - arguments - type: object - refusal: - nullable: true - type: string - tool_calls: - items: - type: object - properties: - function: - properties: - arguments: - description: JSON-encoded arguments string. - type: string - name: - type: string - required: - - name - - arguments - type: object - id: - type: string - type: - enum: - - function - type: string - custom: - properties: - input: - type: string - name: - type: string - required: - - name - - input - type: object - required: - - id - - type - type: array - tool_call_id: - type: string - required: - - role - minItems: 1 - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/nvidia/nemotron-3-120b-a12b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/openai/gpt-oss-120b: - post: - description: Runs inference on the @cf/openai/gpt-oss-120b model. - operationId: workers-ai-post-run-cf-openai-gpt-oss-120b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - input: - description: Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types - type: string - items: {} - reasoning: - properties: - effort: - description: Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - enum: - - low - - medium - - high - type: string - summary: - description: A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed. - enum: - - auto - - concise - - detailed - type: string - type: object - requests: - items: - properties: - input: - description: Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types - type: string - items: {} - reasoning: - properties: - effort: - description: Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - enum: - - low - - medium - - high - type: string - summary: - description: A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed. - enum: - - auto - - concise - - detailed - type: string - type: object - required: - - input - type: object - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/openai/gpt-oss-120b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/openai/gpt-oss-20b: - post: - description: Runs inference on the @cf/openai/gpt-oss-20b model. - operationId: workers-ai-post-run-cf-openai-gpt-oss-20b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - input: - description: Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types - type: string - items: {} - reasoning: - properties: - effort: - description: Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - enum: - - low - - medium - - high - type: string - summary: - description: A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed. - enum: - - auto - - concise - - detailed - type: string - type: object - requests: - items: - properties: - input: - description: Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types - type: string - items: {} - reasoning: - properties: - effort: - description: Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - enum: - - low - - medium - - high - type: string - summary: - description: A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed. - enum: - - auto - - concise - - detailed - type: string - type: object - required: - - input - type: object - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/openai/gpt-oss-20b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/openai/whisper: - post: - description: Runs inference on the @cf/openai/whisper model. - operationId: workers-ai-post-run-cf-openai-whisper - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/octet-stream: - schema: - format: binary - type: string - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/openai/whisper model. - tags: - - Workers AI Automatic Speech Recognition - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/openai/whisper-large-v3-turbo: - post: - description: Runs inference on the @cf/openai/whisper-large-v3-turbo model. - operationId: workers-ai-post-run-cf-openai-whisper-large-v3-turbo - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - audio: - type: string - description: Base64 encoded value of the audio data. - properties: - body: - type: object - contentType: - type: string - beam_size: - default: 5 - description: The number of beams to use in beam search decoding. Higher values may improve accuracy at the cost of speed. - type: integer - compression_ratio_threshold: - default: 2.4 - description: Threshold for filtering out segments with high compression ratio, which often indicate repetitive or hallucinated text. - type: number - condition_on_previous_text: - default: true - description: Whether to condition on previous text during transcription. Setting to false may help prevent hallucination loops. - type: boolean - hallucination_silence_threshold: - description: Optional threshold (in seconds) to skip silent periods that may cause hallucinations. - type: number - initial_prompt: - description: A text prompt to help provide context to the model on the contents of the audio. - type: string - language: - description: The language of the audio being transcribed or translated. - type: string - log_prob_threshold: - default: -1 - description: Threshold for filtering out segments with low average log probability, indicating low confidence. - type: number - no_speech_threshold: - default: 0.6 - description: Threshold for detecting no-speech segments. Segments with no-speech probability above this value are skipped. - type: number - prefix: - description: The prefix appended to the beginning of the output of the transcription and can guide the transcription result. - type: string - task: - default: transcribe - description: Supported tasks are 'translate' or 'transcribe'. - type: string - vad_filter: - default: false - description: Preprocess the audio with a voice activity detection model. - type: boolean - required: - - audio - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/openai/whisper-large-v3-turbo model. - tags: - - Workers AI Automatic Speech Recognition - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en: - post: - description: Runs inference on the @cf/openai/whisper-tiny-en model. - operationId: workers-ai-post-run-cf-openai-whisper-tiny-en - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/octet-stream: - schema: - format: binary - type: string - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/openai/whisper-tiny-en model. - tags: - - Workers AI Automatic Speech Recognition - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106: - post: - description: Runs inference on the @cf/openchat/openchat-3.5-0106 model. - operationId: workers-ai-post-run-cf-openchat-openchat-3-5-0106 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/openchat/openchat-3.5-0106 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/pfnet/plamo-embedding-1b: - post: - description: Runs inference on the @cf/pfnet/plamo-embedding-1b model. - operationId: workers-ai-post-run-cf-pfnet-plamo-embedding-1b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - text: - description: Input text to embed. Can be a single string or a list of strings. - type: string - items: - type: string - required: - - text - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/pfnet/plamo-embedding-1b model. - tags: - - Workers AI Text Embeddings - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat: - post: - description: Runs inference on the @cf/qwen/qwen1.5-0.5b-chat model. - operationId: workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen1.5-0.5b-chat model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-1.8b-chat: - post: - description: Runs inference on the @cf/qwen/qwen1.5-1.8b-chat model. - operationId: workers-ai-post-run-cf-qwen-qwen1-5-1-8b-chat - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen1.5-1.8b-chat model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-14b-chat-awq: - post: - description: Runs inference on the @cf/qwen/qwen1.5-14b-chat-awq model. - operationId: workers-ai-post-run-cf-qwen-qwen1-5-14b-chat-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen1.5-14b-chat-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-7b-chat-awq: - post: - description: Runs inference on the @cf/qwen/qwen1.5-7b-chat-awq model. - operationId: workers-ai-post-run-cf-qwen-qwen1-5-7b-chat-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen1.5-7b-chat-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen2.5-coder-32b-instruct: - post: - description: Runs inference on the @cf/qwen/qwen2.5-coder-32b-instruct model. - operationId: workers-ai-post-run-cf-qwen-qwen2-5-coder-32b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - description: The content of the message as a string. - type: string - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen2.5-coder-32b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen3-30b-a3b-fp8: - post: - description: Runs inference on the @cf/qwen/qwen3-30b-a3b-fp8 model. - operationId: workers-ai-post-run-cf-qwen-qwen3-30b-a3b-fp8 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 2000 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - requests: - items: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen3-30b-a3b-fp8 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwen3-embedding-0.6b: - post: - description: Runs inference on the @cf/qwen/qwen3-embedding-0.6b model. - operationId: workers-ai-post-run-cf-qwen-qwen3-embedding-0-6b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - documents: - type: string - description: A single document string - items: - minLength: 1 - type: string - instruction: - default: Given a web search query, retrieve relevant passages that answer the query - description: Optional instruction for the task - type: string - queries: - type: string - description: A single query string - items: - minLength: 1 - type: string - text: - type: string - description: 'Alias for documents: a single text string' - items: - minLength: 1 - type: string - type: object - responses: - '200': - content: - application/json: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwen3-embedding-0.6b model. - tags: - - Workers AI Text Embeddings - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/qwen/qwq-32b: - post: - description: Runs inference on the @cf/qwen/qwq-32b model. - operationId: workers-ai-post-run-cf-qwen-qwq-32b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: 0 - type: number - guided_json: - description: JSON schema that should be fulfilled for the response. - type: object - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: 0 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.15 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 2 - minimum: 0 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - type: object - properties: - image_url: - properties: - url: - description: image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted - type: string - type: object - text: - type: string - type: - description: Type of the content provided - type: string - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - tool_call_id: - description: The tool call id. If you don't know what to put here you can fall back to 000000001 - type: string - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/qwen/qwq-32b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img: - post: - description: Runs inference on the @cf/runwayml/stable-diffusion-v1-5-img2img model. - operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-img2img - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - guidance: - default: 7.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - type: number - height: - description: The height of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - image: - description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - image_b64: - description: For use with img2img tasks. A base64-encoded string of the input image - type: string - mask: - description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - negative_prompt: - description: Text describing elements to avoid in the generated image - type: string - num_steps: - default: 20 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 20 - type: integer - prompt: - description: A text description of the image you want to generate - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - type: integer - strength: - default: 1 - description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - type: number - width: - description: The width of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - image/png: - schema: - format: binary - type: string - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/runwayml/stable-diffusion-v1-5-img2img model. - tags: - - Workers AI Text To Image - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting: - post: - description: Runs inference on the @cf/runwayml/stable-diffusion-v1-5-inpainting model. - operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-inpainting - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - guidance: - default: 7.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - type: number - height: - description: The height of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - image: - description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - image_b64: - description: For use with img2img tasks. A base64-encoded string of the input image - type: string - mask: - description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - negative_prompt: - description: Text describing elements to avoid in the generated image - type: string - num_steps: - default: 20 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 20 - type: integer - prompt: - description: A text description of the image you want to generate - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - type: integer - strength: - default: 1 - description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - type: number - width: - description: The width of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - image/png: - schema: - format: binary - type: string - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model. - tags: - - Workers AI Text To Image - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0: - post: - description: Runs inference on the @cf/stabilityai/stable-diffusion-xl-base-1.0 model. - operationId: workers-ai-post-run-cf-stabilityai-stable-diffusion-xl-base-1-0 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - guidance: - default: 7.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - type: number - height: - description: The height of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - image: - description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - image_b64: - description: For use with img2img tasks. A base64-encoded string of the input image - type: string - mask: - description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - negative_prompt: - description: Text describing elements to avoid in the generated image - type: string - num_steps: - default: 20 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 20 - type: integer - prompt: - description: A text description of the image you want to generate - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - type: integer - strength: - default: 1 - description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - type: number - width: - description: The width of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - required: - - prompt - type: object - responses: - '200': - content: - application/json: - schema: - type: object - image/png: - schema: - format: binary - type: string - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model. - tags: - - Workers AI Text To Image - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/thebloke/discolm-german-7b-v1-awq: - post: - description: Runs inference on the @cf/thebloke/discolm-german-7b-v1-awq model. - operationId: workers-ai-post-run-cf-thebloke-discolm-german-7b-v1-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/thebloke/discolm-german-7b-v1-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/tiiuae/falcon-7b-instruct: - post: - description: Runs inference on the @cf/tiiuae/falcon-7b-instruct model. - operationId: workers-ai-post-run-cf-tiiuae-falcon-7b-instruct - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/tiiuae/falcon-7b-instruct model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0: - post: - description: Runs inference on the @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model. - operationId: workers-ai-post-run-cf-tinyllama-tinyllama-1-1b-chat-v1-0 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@cf/zai-org/glm-4.7-flash: - post: - description: Runs inference on the @cf/zai-org/glm-4.7-flash model. - operationId: workers-ai-post-run-cf-zai-org-glm-4-7-flash - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - audio: - description: Parameters for audio output. Required when modalities includes 'audio'. - properties: - format: - enum: - - wav - - aac - - mp3 - - flac - - opus - - pcm16 - type: string - voice: - type: string - properties: - id: - type: string - required: - - id - required: - - voice - - format - type: object - chat_template_kwargs: - properties: - clear_thinking: - default: false - description: If false, preserves reasoning context between turns. - type: boolean - enable_thinking: - default: true - description: Whether to enable reasoning, enabled by default. - type: boolean - type: object - frequency_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - function_call: - type: string - enum: - - none - - auto - properties: - name: - type: string - required: - - name - functions: - items: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - maxItems: 128 - minItems: 1 - type: array - logit_bias: - nullable: true - type: object - logprobs: - nullable: true - type: boolean - max_completion_tokens: - nullable: true - type: integer - max_tokens: - nullable: true - type: integer - metadata: - nullable: true - type: object - modalities: - items: - enum: - - text - - audio - type: string - nullable: true - type: array - model: - description: ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - type: string - 'n': - maximum: 128 - minimum: 1 - nullable: true - type: integer - parallel_tool_calls: - default: true - description: Whether to enable parallel function calling during tool use. - type: boolean - prediction: - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - type: - enum: - - content - type: string - required: - - type - - content - type: object - presence_penalty: - maximum: 2 - minimum: -2 - nullable: true - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - reasoning_effort: - enum: - - low - - medium - - high - nullable: true - type: string - response_format: - description: Specifies the format the model must output. - type: object - properties: - type: - enum: - - text - type: string - json_schema: - properties: - description: - type: string - name: - type: string - schema: - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - required: - - type - seed: - nullable: true - type: integer - service_tier: - enum: - - auto - - default - - flex - - scale - - priority - nullable: true - type: string - stop: - type: string - items: - type: string - store: - nullable: true - type: boolean - stream: - nullable: true - type: boolean - stream_options: - properties: - include_obfuscation: - type: boolean - include_usage: - type: boolean - type: object - temperature: - maximum: 2 - minimum: 0 - nullable: true - type: number - tool_choice: - description: Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - type: string - enum: - - none - - auto - - required - properties: - function: - properties: - name: - type: string - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - name: - type: string - required: - - name - type: object - allowed_tools: - properties: - mode: - enum: - - auto - - required - type: string - tools: - items: - type: object - type: array - required: - - mode - - tools - type: object - required: - - type - tools: - description: A list of tools the model may call. - items: - type: object - properties: - function: - properties: - description: - description: A description of what the function does. - type: string - name: - description: The name of the function to be called. - type: string - parameters: - description: The parameters the function accepts, described as a JSON Schema object. - type: object - strict: - nullable: true - type: boolean - required: - - name - type: object - type: - enum: - - function - type: string - custom: - properties: - description: - type: string - format: - type: object - properties: - type: - enum: - - text - type: string - grammar: - properties: - definition: - type: string - syntax: - enum: - - lark - - regex - type: string - required: - - definition - - syntax - type: object - required: - - type - name: - type: string - required: - - name - type: object - required: - - type - type: array - top_logprobs: - maximum: 20 - minimum: 0 - nullable: true - type: integer - top_p: - maximum: 1 - minimum: 0 - nullable: true - type: number - user: - description: A unique identifier representing your end-user, for abuse monitoring. - type: string - web_search_options: - description: Options for the web search tool (when using built-in web search). - properties: - search_context_size: - default: medium - enum: - - low - - medium - - high - type: string - user_location: - properties: - approximate: - properties: - city: - type: string - country: - type: string - region: - type: string - timezone: - type: string - type: object - type: - enum: - - approximate - type: string - required: - - type - - approximate - type: object - type: object - messages: - description: A list of messages comprising the conversation so far. - items: - type: object - properties: - content: - type: string - items: - properties: - text: - type: string - type: - enum: - - text - type: string - required: - - type - - text - type: object - name: - type: string - role: - enum: - - developer - type: string - audio: - properties: - id: - type: string - required: - - id - type: object - function_call: - properties: - arguments: - type: string - name: - type: string - required: - - name - - arguments - type: object - refusal: - nullable: true - type: string - tool_calls: - items: - type: object - properties: - function: - properties: - arguments: - description: JSON-encoded arguments string. - type: string - name: - type: string - required: - - name - - arguments - type: object - id: - type: string - type: - enum: - - function - type: string - custom: - properties: - input: - type: string - name: - type: string - required: - - name - - input - type: object - required: - - id - - type - type: array - tool_call_id: - type: string - required: - - role - minItems: 1 - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @cf/zai-org/glm-4.7-flash model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/google/gemma-7b-it: - post: - description: Runs inference on the @hf/google/gemma-7b-it model. - operationId: workers-ai-post-run-hf-google-gemma-7b-it - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/google/gemma-7b-it model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/mistral/mistral-7b-instruct-v0.2: - post: - description: Runs inference on the @hf/mistral/mistral-7b-instruct-v0.2 model. - operationId: workers-ai-post-run-hf-mistral-mistral-7b-instruct-v0-2 - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/mistral/mistral-7b-instruct-v0.2 model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/nexusflow/starling-lm-7b-beta: - post: - description: Runs inference on the @hf/nexusflow/starling-lm-7b-beta model. - operationId: workers-ai-post-run-hf-nexusflow-starling-lm-7b-beta - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/nexusflow/starling-lm-7b-beta model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/nousresearch/hermes-2-pro-mistral-7b: - post: - description: Runs inference on the @hf/nousresearch/hermes-2-pro-mistral-7b model. - operationId: workers-ai-post-run-hf-nousresearch-hermes-2-pro-mistral-7b - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/nousresearch/hermes-2-pro-mistral-7b model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq: - post: - description: Runs inference on the @hf/thebloke/deepseek-coder-6.7b-base-awq model. - operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-base-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq: - post: - description: Runs inference on the @hf/thebloke/deepseek-coder-6.7b-instruct-awq model. - operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-instruct-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/llama-2-13b-chat-awq: - post: - description: Runs inference on the @hf/thebloke/llama-2-13b-chat-awq model. - operationId: workers-ai-post-run-hf-thebloke-llama-2-13b-chat-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/llama-2-13b-chat-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq: - post: - description: Runs inference on the @hf/thebloke/mistral-7b-instruct-v0.1-awq model. - operationId: workers-ai-post-run-hf-thebloke-mistral-7b-instruct-v0-1-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq: - post: - description: Runs inference on the @hf/thebloke/neural-chat-7b-v3-1-awq model. - operationId: workers-ai-post-run-hf-thebloke-neural-chat-7b-v3-1-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/neural-chat-7b-v3-1-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq: - post: - description: Runs inference on the @hf/thebloke/openhermes-2.5-mistral-7b-awq model. - operationId: workers-ai-post-run-hf-thebloke-openhermes-2-5-mistral-7b-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq: - post: - description: Runs inference on the @hf/thebloke/zephyr-7b-beta-awq model. - operationId: workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: queueRequest - schema: - type: string - x-auditable: true - - in: query - name: tags - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - title: Prompt - properties: - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - prompt: - description: The input text prompt for the model to generate a response. - minLength: 1 - type: string - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - seed: - description: Random seed for reproducibility of the generation. - maximum: 9999999999 - minimum: 1 - type: integer - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - responses: - '200': - content: - application/json: - schema: - type: object - text/event-stream: - schema: - type: object - description: Object with user data. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: string - message: - type: string - required: - - code - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - errors - - success - - result - type: object - description: Bad request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute @hf/thebloke/zephyr-7b-beta-awq model. - tags: - - Workers AI Text Generation - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/run/{model_name}: - post: - description: This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). - operationId: workers-ai-post-run-model - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: path - name: model_name - schema: - type: string - required: true - requestBody: - content: - application/json: - schema: - type: object - title: Text Classification - properties: - text: - description: The text that you want to classify - minLength: 1 - type: string - guidance: - default: 7.5 - description: Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - type: number - height: - description: The height of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - image: - description: For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - image_b64: - description: For use with img2img tasks. A base64-encoded string of the input image - type: string - mask: - description: An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - negative_prompt: - description: Text describing elements to avoid in the generated image - type: string - num_steps: - default: 20 - description: The number of diffusion steps; higher values can improve quality but take longer - maximum: 20 - type: integer - prompt: - description: A text description of the image you want to generate - minLength: 1 - type: string - seed: - description: Random seed for reproducibility of the image generation - type: integer - strength: - default: 1 - description: A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - type: number - width: - description: The width of the generated image in pixels - maximum: 2048 - minimum: 256 - type: integer - lang: - default: en - description: The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified - type: string - audio: - description: An array of integers that represent the audio data constrained to 8-bit unsigned integer values - items: - description: A value between 0 and 255 - type: number - type: array - source_lang: - description: The language of the recorded audio - type: string - target_lang: - description: The language to translate the transcription into. Currently only English is supported. - type: string - frequency_penalty: - description: Decreases the likelihood of the model repeating the same lines verbatim. - maximum: 2 - minimum: -2 - type: number - lora: - description: Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - type: string - max_tokens: - default: 256 - description: The maximum number of tokens to generate in the response. - type: integer - presence_penalty: - description: Increases the likelihood of the model introducing new topics. - maximum: 2 - minimum: -2 - type: number - raw: - default: false - description: If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - type: boolean - repetition_penalty: - description: Penalty for repeated tokens; higher values discourage repetition. - maximum: 2 - minimum: 0 - type: number - response_format: - properties: - json_schema: {} - type: - enum: - - json_object - - json_schema - type: string - title: JSON Mode - type: object - stream: - default: false - description: If true, the response will be streamed back incrementally using SSE, Server Sent Events. - type: boolean - temperature: - default: 0.6 - description: Controls the randomness of the output; higher values produce more random results. - maximum: 5 - minimum: 0 - type: number - top_k: - description: Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - maximum: 50 - minimum: 1 - type: integer - top_p: - description: Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - maximum: 1 - minimum: 0.001 - type: number - functions: - items: - properties: - code: - type: string - name: - type: string - required: - - name - - code - type: object - type: array - messages: - description: An array of message objects representing the conversation history. - items: - properties: - content: - type: string - description: The content of the message as a string. - items: - properties: - text: - description: Text content - type: string - type: - description: Type of the content (text) - type: string - type: object - role: - description: The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). - type: string - required: - - role - - content - type: object - type: array - tools: - description: A list of tools available for the assistant to use. - items: - type: object - properties: - description: - description: A brief description of what the tool does. - type: string - name: - description: The name of the tool. More descriptive the better. - type: string - parameters: - description: Schema defining the parameters accepted by the tool. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - function: - description: Details of the function tool. - properties: - description: - description: A brief description of what the function does. - type: string - name: - description: The name of the function. - type: string - parameters: - description: Schema defining the parameters accepted by the function. - properties: - properties: - description: Definitions of each parameter. - type: object - required: - description: List of required parameter names. - items: - type: string - type: array - type: - description: The type of the parameters object (usually 'object'). - type: string - required: - - type - - properties - type: object - required: - - name - - description - - parameters - type: object - type: - description: Specifies the type of tool (e.g., 'function'). - type: string - type: array - input_text: - description: The text that you want the model to summarize - minLength: 1 - type: string - max_length: - default: 1024 - description: The maximum length of the generated summary in tokens - type: integer - ignore_eos: - description: Whether to ignore the EOS token and continue generating tokens after the EOS token is generated. - type: boolean - responses: - '200': - content: - application/json: - schema: - properties: - result: - type: object - title: Text Classification - description: An array of classification results for the input text - items: - properties: - label: - description: The classification label assigned to the text (e.g., 'POSITIVE' or 'NEGATIVE') - type: string - score: - description: Confidence score indicating the likelihood that the text belongs to the specified label - type: number - type: object - format: binary - properties: - audio: - description: The generated audio in MP3 format, base64-encoded - type: string - data: - description: Embeddings of the requested text values - items: - description: Floating point embedding representation shaped by the embedding model - items: - type: number - type: array - type: array - shape: - items: - type: number - type: array - text: - description: The transcription - type: string - vtt: - type: string - word_count: - type: number - words: - items: - properties: - end: - description: The ending second when the word completes - type: number - start: - description: The second this word begins in the recording - type: number - word: - type: string - type: object - type: array - response: - description: The generated text response from the model - type: string - tool_calls: - description: An array of tool calls requests made during the response generation - items: - properties: - arguments: - description: The arguments passed to be passed to the tool call request - type: object - name: - description: The name of the tool to be called - type: string - type: object - type: array - usage: - description: Usage statistics for the inference request - properties: - completion_tokens: - default: 0 - description: Total number of tokens in output - type: number - prompt_tokens: - default: 0 - description: Total number of tokens in input - type: number - total_tokens: - default: 0 - description: Total number of input and output tokens - type: number - type: object - translated_text: - description: The translated text in the target language - type: string - summary: - description: The summarized version of the input text - type: string - description: - type: string - required: [] - type: object - description: Model response - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - message: - type: string - required: - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - result - - success - - errors - type: object - description: Bad Request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Execute AI model - tags: - - Workers AI - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: ai - resource_chain: [] - method: run - /accounts/{account_id}/ai/tasks/search: - get: - description: Searches Workers AI models by task type (e.g., text-generation, embeddings). - operationId: workers-ai-search-task - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - errors: - items: - type: object - type: array - messages: - items: - type: string - type: array - result: - items: - type: object - type: array - success: - type: boolean - x-auditable: true - required: - - success - - result - - errors - - messages - type: object - description: Returns a list of tasks - '404': - content: - application/json: - schema: - properties: - errors: - items: - type: object - type: array - success: - type: boolean - required: - - success - - errors - type: object - description: Object not found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Task Search - tags: - - Workers AI - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: ai - resource_chain: - - tasks - method: list - /accounts/{account_id}/ai/tomarkdown: - post: - description: Converts uploaded files into Markdown format using Workers AI. - operationId: workers-ai-post-to-markdown - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - multipart/form-data: - schema: - properties: - files: - items: - format: binary - type: string - type: array - required: - - files - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - data: - type: string - x-auditable: true - format: - type: string - x-auditable: true - mimeType: - type: string - x-auditable: true - name: - type: string - x-auditable: true - tokens: - type: string - x-auditable: true - required: - - name - - mimeType - - format - - tokens - - data - type: object - type: array - success: - type: boolean - required: - - success - - result - type: object - description: Model Schema - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - message: - type: string - required: - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - result - - success - - errors - type: object - description: Bad Request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Convert Files into Markdown - tags: - - Workers AI - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai/tomarkdown/supported: - get: - description: Lists all file formats supported for conversion to Markdown. - operationId: workers-ai-get-to-markdown-supported - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - extension: - type: string - x-auditable: true - mimeType: - type: string - x-auditable: true - required: - - extension - - mimeType - type: object - type: array - success: - type: boolean - required: - - success - - result - type: object - description: Successful response - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - message: - type: string - required: - - message - type: object - type: array - result: - type: object - success: - type: boolean - required: - - result - - success - - errors - type: object - description: Bad Request - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Get all converted formats supported - tags: - - Workers AI - x-api-token-group: - - Workers AI Write - - Workers AI Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: ai - resource_chain: - - to_markdown - method: supported - /accounts/{account_id}/autorag/rags/{id}/ai-search: - post: - operationId: autorag-config-ai-search - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - filters: - type: object - properties: - key: - type: string - type: - enum: - - eq - - ne - - gt - - gte - - lt - - lte - type: string - value: - type: string - filters: - items: - properties: - key: - type: string - type: - enum: - - eq - - ne - - gt - - gte - - lt - - lte - type: string - value: - type: string - required: - - key - - type - - value - type: object - type: array - required: - - type - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - query: - type: string - ranking_options: - default: {} - properties: - ranker: - type: string - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - type: object - reranking: - properties: - enabled: - default: false - type: boolean - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - rewrite_query: - default: false - type: boolean - stream: - default: false - type: boolean - system_prompt: - type: string - required: - - query - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - data: - items: - properties: - attributes: - type: object - content: - items: - properties: - text: - type: string - type: - type: string - type: object - type: array - file_id: - type: string - filename: - type: string - score: - type: number - required: - - score - type: object - type: array - has_more: - default: false - type: boolean - next_page: - nullable: true - type: string - object: - type: string - response: - type: string - search_query: - type: string - required: - - search_query - - response - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the log details - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: AI Search - tags: - - AutoRAG RAG Search - x-api-token-group: - - Auto Rag Write - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/autorag/rags/{id}/files: - get: - operationId: autorag-config-files - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 50 - minimum: 0 - type: integer - - in: query - name: search - schema: - type: string - - in: query - name: status - schema: - enum: - - completed - - queued - - running - - error - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - error: - type: string - key: - type: string - required: - - key - - error - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - default: 20 - maximum: 50 - minimum: 5 - type: integer - total_count: - type: integer - required: - - count - - page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns the AI Search files - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: autorag_not_found - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: unable_to_connect_to_autorag - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Files - tags: - - AutoRAG RAG - x-api-token-group: - - Auto Rag Write - - Auto Rag Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/autorag/rags/{id}/jobs: - get: - operationId: autorag-config-list-jobs - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 50 - minimum: 0 - type: integer - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - end_reason: - type: string - ended_at: - type: string - id: - type: string - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - started_at: - type: string - required: - - id - - source - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - type: integer - total_count: - type: integer - required: - - count - - page - - per_page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns a list of AutoRAG Jobs - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: autorag_not_found - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: unable_to_connect_to_autorag - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Jobs - tags: - - AutoRAG Jobs - x-api-token-group: - - Auto Rag Write - - Auto Rag Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}: - get: - operationId: autorag-config-get-job - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - end_reason: - type: string - ended_at: - type: string - id: - type: string - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns a AutoRAG Job Details - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: job_not_found - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: unable_to_connect_to_autorag - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Get a Job Details - tags: - - AutoRAG Jobs - x-api-token-group: - - Auto Rag Write - - Auto Rag Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}/logs: - get: - operationId: autorag-config-list-job-logs - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 500 - minimum: 0 - type: integer - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - created_at: - type: number - readOnly: true - id: - type: integer - message: - type: string - message_type: - type: integer - required: - - id - - message - - message_type - - created_at - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - type: integer - total_count: - type: integer - required: - - count - - page - - per_page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns a list of AutoRAG Job Logs - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: autorag_not_found - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: unable_to_connect_to_autorag - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Job Logs - tags: - - AutoRAG Jobs - x-api-token-group: - - Auto Rag Write - - Auto Rag Read - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/autorag/rags/{id}/search: - post: - operationId: autorag-config-search - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - filters: - type: object - properties: - key: - type: string - type: - enum: - - eq - - ne - - gt - - gte - - lt - - lte - type: string - value: - type: string - filters: - items: - properties: - key: - type: string - type: - enum: - - eq - - ne - - gt - - gte - - lt - - lte - type: string - value: - type: string - required: - - key - - type - - value - type: object - type: array - required: - - type - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - query: - type: string - ranking_options: - default: {} - properties: - ranker: - type: string - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - type: object - reranking: - properties: - enabled: - default: false - type: boolean - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - rewrite_query: - default: false - type: boolean - required: - - query - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - data: - items: - properties: - attributes: - type: object - content: - items: - properties: - text: - type: string - type: - type: string - type: object - type: array - file_id: - type: string - filename: - type: string - score: - type: number - required: - - score - type: object - type: array - has_more: - default: false - type: boolean - next_page: - nullable: true - type: string - object: - type: string - search_query: - type: string - required: - - search_query - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the log details - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Search - tags: - - AutoRAG RAG Search - x-api-token-group: - - Auto Rag Write - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/autorag/rags/{id}/sync: - patch: - operationId: autorag-config-sync - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - job_id: - type: string - required: - - job_id - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the autorag sync status - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: autorag_is_paused - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: autorag_not_found - '429': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: sync_in_cooldown - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: unable_to_connect_to_autorag - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Sync - tags: - - AutoRAG RAG - x-api-token-group: - - Auto Rag Write - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.rag - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true -components: - schemas: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. - api_key: - in: header - name: X-Auth-Key - type: apiKey - description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. - api_token: - scheme: bearer - type: http - description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). - x-stackQL-resources: - authors: - id: cloudflare.ai.authors - name: authors - title: Authors - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1authors~1search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/authors/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - finetunes: - id: cloudflare.ai.finetunes - name: finetunes - title: Finetunes - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/finetunes/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/finetunes/methods/create' - update: [] - delete: [] - replace: [] - public: - id: cloudflare.ai.public - name: public - title: Public - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes~1public/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/public/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - assets: - id: cloudflare.ai.assets - name: assets - title: Assets - methods: - create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes~1{finetune_id}~1finetune-assets/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/assets/methods/create' - update: [] - delete: [] - replace: [] - schema: - id: cloudflare.ai.schema - name: schema - title: Schema - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1models~1schema/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/schema/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - models: - id: cloudflare.ai.models - name: models - title: Models - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1models~1search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/models/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - indictrans2_en_indic_1_b: - id: cloudflare.ai.indictrans2_en_indic_1_b - name: indictrans2_en_indic_1_b - title: Indictrans2 En Indic 1 B - methods: - workers_ai_post_run_cf_ai4bharat_indictrans2_en_indic_1_b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1ai4bharat~1indictrans2-en-indic-1B/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/indictrans2_en_indic_1_b/methods/workers_ai_post_run_cf_ai4bharat_indictrans2_en_indic_1_b' - update: [] - delete: [] - replace: [] - nonomni_indictrans2_en_indic_1b: - id: cloudflare.ai.nonomni_indictrans2_en_indic_1b - name: nonomni_indictrans2_en_indic_1b - title: Nonomni Indictrans2 En Indic 1b - methods: - workers_ai_post_run_cf_ai4bharat_nonomni_indictrans2_en_indic_1b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1ai4bharat~1nonomni-indictrans2-en-indic-1b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_indictrans2_en_indic_1b/methods/workers_ai_post_run_cf_ai4bharat_nonomni_indictrans2_en_indic_1b' - update: [] - delete: [] - replace: [] - gemma_sea_lion_v4_27b_it: - id: cloudflare.ai.gemma_sea_lion_v4_27b_it - name: gemma_sea_lion_v4_27b_it - title: Gemma Sea Lion V4 27b It - methods: - workers_ai_post_run_cf_aisingapore_gemma_sea_lion_v4_27b_it: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1aisingapore~1gemma-sea-lion-v4-27b-it/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gemma_sea_lion_v4_27b_it/methods/workers_ai_post_run_cf_aisingapore_gemma_sea_lion_v4_27b_it' - update: [] - delete: [] - replace: [] - bge_base_en_v1_5: - id: cloudflare.ai.bge_base_en_v1_5 - name: bge_base_en_v1_5 - title: Bge Base En V1 5 - methods: - workers_ai_post_run_cf_baai_bge_base_en_v1_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-base-en-v1.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bge_base_en_v1_5/methods/workers_ai_post_run_cf_baai_bge_base_en_v1_5' - update: [] - delete: [] - replace: [] - bge_large_en_v1_5: - id: cloudflare.ai.bge_large_en_v1_5 - name: bge_large_en_v1_5 - title: Bge Large En V1 5 - methods: - workers_ai_post_run_cf_baai_bge_large_en_v1_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-large-en-v1.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bge_large_en_v1_5/methods/workers_ai_post_run_cf_baai_bge_large_en_v1_5' - update: [] - delete: [] - replace: [] - bge_m3: - id: cloudflare.ai.bge_m3 - name: bge_m3 - title: Bge M3 - methods: - workers_ai_post_run_cf_baai_bge_m3: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-m3/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .contexts }}{{ $sep }}"contexts": {{ if eq (kindOf .contexts) "string" }}{{ .contexts }}{{ else }}{{ toJson .contexts }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - - {{- if .truncate_inputs }}{{ $sep }}"truncate_inputs": {{ toJson .truncate_inputs }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bge_m3/methods/workers_ai_post_run_cf_baai_bge_m3' - update: [] - delete: [] - replace: [] - bge_reranker_base: - id: cloudflare.ai.bge_reranker_base - name: bge_reranker_base - title: Bge Reranker Base - methods: - workers_ai_post_run_cf_baai_bge_reranker_base: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-reranker-base/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .contexts }}{{ $sep }}"contexts": {{ if eq (kindOf .contexts) "string" }}{{ .contexts }}{{ else }}{{ toJson .contexts }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bge_reranker_base/methods/workers_ai_post_run_cf_baai_bge_reranker_base' - update: [] - delete: [] - replace: [] - bge_small_en_v1_5: - id: cloudflare.ai.bge_small_en_v1_5 - name: bge_small_en_v1_5 - title: Bge Small En V1 5 - methods: - workers_ai_post_run_cf_baai_bge_small_en_v1_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-small-en-v1.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bge_small_en_v1_5/methods/workers_ai_post_run_cf_baai_bge_small_en_v1_5' - update: [] - delete: [] - replace: [] - nonomni_bge_base_en_v1_5: - id: cloudflare.ai.nonomni_bge_base_en_v1_5 - name: nonomni_bge_base_en_v1_5 - title: Nonomni Bge Base En V1 5 - methods: - workers_ai_post_run_cf_baai_nonomni_bge_base_en_v1_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-base-en-v1.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_bge_base_en_v1_5/methods/workers_ai_post_run_cf_baai_nonomni_bge_base_en_v1_5' - update: [] - delete: [] - replace: [] - nonomni_bge_large_en_v1_5: - id: cloudflare.ai.nonomni_bge_large_en_v1_5 - name: nonomni_bge_large_en_v1_5 - title: Nonomni Bge Large En V1 5 - methods: - workers_ai_post_run_cf_baai_nonomni_bge_large_en_v1_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-large-en-v1.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_bge_large_en_v1_5/methods/workers_ai_post_run_cf_baai_nonomni_bge_large_en_v1_5' - update: [] - delete: [] - replace: [] - nonomni_bge_m3: - id: cloudflare.ai.nonomni_bge_m3 - name: nonomni_bge_m3 - title: Nonomni Bge M3 - methods: - workers_ai_post_run_cf_baai_nonomni_bge_m3: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-m3/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .contexts }}{{ $sep }}"contexts": {{ if eq (kindOf .contexts) "string" }}{{ .contexts }}{{ else }}{{ toJson .contexts }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - - {{- if .truncate_inputs }}{{ $sep }}"truncate_inputs": {{ toJson .truncate_inputs }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_bge_m3/methods/workers_ai_post_run_cf_baai_nonomni_bge_m3' - update: [] - delete: [] - replace: [] - nonomni_bge_small_en_v1_5: - id: cloudflare.ai.nonomni_bge_small_en_v1_5 - name: nonomni_bge_small_en_v1_5 - title: Nonomni Bge Small En V1 5 - methods: - workers_ai_post_run_cf_baai_nonomni_bge_small_en_v1_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-small-en-v1.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_bge_small_en_v1_5/methods/workers_ai_post_run_cf_baai_nonomni_bge_small_en_v1_5' - update: [] - delete: [] - replace: [] - flux_1_schnell: - id: cloudflare.ai.flux_1_schnell - name: flux_1_schnell - title: Flux 1 Schnell - methods: - workers_ai_post_run_cf_black_forest_labs_flux_1_schnell: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-1-schnell/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/flux_1_schnell/methods/workers_ai_post_run_cf_black_forest_labs_flux_1_schnell' - update: [] - delete: [] - replace: [] - flux_2_dev: - id: cloudflare.ai.flux_2_dev - name: flux_2_dev - title: Flux 2 Dev - methods: - workers_ai_post_run_cf_black_forest_labs_flux_2_dev: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-2-dev/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .multipart }}{{ $sep }}"multipart": {{ if eq (kindOf .multipart) "string" }}{{ .multipart }}{{ else }}{{ toJson .multipart }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/flux_2_dev/methods/workers_ai_post_run_cf_black_forest_labs_flux_2_dev' - update: [] - delete: [] - replace: [] - flux_2_klein_4b: - id: cloudflare.ai.flux_2_klein_4b - name: flux_2_klein_4b - title: Flux 2 Klein 4b - methods: - workers_ai_post_run_cf_black_forest_labs_flux_2_klein_4b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-2-klein-4b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .multipart }}{{ $sep }}"multipart": {{ if eq (kindOf .multipart) "string" }}{{ .multipart }}{{ else }}{{ toJson .multipart }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/flux_2_klein_4b/methods/workers_ai_post_run_cf_black_forest_labs_flux_2_klein_4b' - update: [] - delete: [] - replace: [] - flux_2_klein_9b: - id: cloudflare.ai.flux_2_klein_9b - name: flux_2_klein_9b - title: Flux 2 Klein 9b - methods: - workers_ai_post_run_cf_black_forest_labs_flux_2_klein_9b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-2-klein-9b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .multipart }}{{ $sep }}"multipart": {{ if eq (kindOf .multipart) "string" }}{{ .multipart }}{{ else }}{{ toJson .multipart }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/flux_2_klein_9b/methods/workers_ai_post_run_cf_black_forest_labs_flux_2_klein_9b' - update: [] - delete: [] - replace: [] - stable_diffusion_xl_lightning: - id: cloudflare.ai.stable_diffusion_xl_lightning - name: stable_diffusion_xl_lightning - title: Stable Diffusion Xl Lightning - methods: - workers_ai_post_run_cf_bytedance_stable_diffusion_xl_lightning: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1bytedance~1stable-diffusion-xl-lightning/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - - {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - - {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} - - {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/stable_diffusion_xl_lightning/methods/workers_ai_post_run_cf_bytedance_stable_diffusion_xl_lightning' - update: [] - delete: [] - replace: [] - aura_1: - id: cloudflare.ai.aura_1 - name: aura_1 - title: Aura 1 - methods: - workers_ai_post_run_cf_deepgram_aura_1: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1aura-1/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/aura_1/methods/workers_ai_post_run_cf_deepgram_aura_1' - update: [] - delete: [] - replace: [] - aura_2_en: - id: cloudflare.ai.aura_2_en - name: aura_2_en - title: Aura 2 En - methods: - workers_ai_post_run_cf_deepgram_aura_2_en: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1aura-2-en/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/aura_2_en/methods/workers_ai_post_run_cf_deepgram_aura_2_en' - update: [] - delete: [] - replace: [] - aura_2_es: - id: cloudflare.ai.aura_2_es - name: aura_2_es - title: Aura 2 Es - methods: - workers_ai_post_run_cf_deepgram_aura_2_es: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1aura-2-es/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/aura_2_es/methods/workers_ai_post_run_cf_deepgram_aura_2_es' - update: [] - delete: [] - replace: [] - flux: - id: cloudflare.ai.flux - name: flux - title: Flux - methods: - workers_ai_post_run_cf_deepgram_flux: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1flux/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/flux/methods/workers_ai_post_run_cf_deepgram_flux' - update: [] - delete: [] - replace: [] - nova_3: - id: cloudflare.ai.nova_3 - name: nova_3 - title: Nova 3 - methods: - workers_ai_post_run_cf_deepgram_nova_3: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1nova-3/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .channels }}{{ $sep }}"channels": {{ toJson .channels }}{{- $sep = "," -}}{{ end }} - - {{- if .custom_intent }}{{ $sep }}"custom_intent": {{ toJson .custom_intent }}{{- $sep = "," -}}{{ end }} - - {{- if .custom_intent_mode }}{{ $sep }}"custom_intent_mode": {{ toJson .custom_intent_mode }}{{- $sep = "," -}}{{ end }} - - {{- if .custom_topic }}{{ $sep }}"custom_topic": {{ toJson .custom_topic }}{{- $sep = "," -}}{{ end }} - - {{- if .custom_topic_mode }}{{ $sep }}"custom_topic_mode": {{ toJson .custom_topic_mode }}{{- $sep = "," -}}{{ end }} - - {{- if .detect_entities }}{{ $sep }}"detect_entities": {{ toJson .detect_entities }}{{- $sep = "," -}}{{ end }} - - {{- if .detect_language }}{{ $sep }}"detect_language": {{ toJson .detect_language }}{{- $sep = "," -}}{{ end }} - - {{- if .diarize }}{{ $sep }}"diarize": {{ toJson .diarize }}{{- $sep = "," -}}{{ end }} - - {{- if .dictation }}{{ $sep }}"dictation": {{ toJson .dictation }}{{- $sep = "," -}}{{ end }} - - {{- if .encoding }}{{ $sep }}"encoding": {{ toJson .encoding }}{{- $sep = "," -}}{{ end }} - - {{- if .endpointing }}{{ $sep }}"endpointing": {{ toJson .endpointing }}{{- $sep = "," -}}{{ end }} - - {{- if .extra }}{{ $sep }}"extra": {{ toJson .extra }}{{- $sep = "," -}}{{ end }} - - {{- if .filler_words }}{{ $sep }}"filler_words": {{ toJson .filler_words }}{{- $sep = "," -}}{{ end }} - - {{- if .interim_results }}{{ $sep }}"interim_results": {{ toJson .interim_results }}{{- $sep = "," -}}{{ end }} - - {{- if .keyterm }}{{ $sep }}"keyterm": {{ toJson .keyterm }}{{- $sep = "," -}}{{ end }} - - {{- if .keywords }}{{ $sep }}"keywords": {{ toJson .keywords }}{{- $sep = "," -}}{{ end }} - - {{- if .language }}{{ $sep }}"language": {{ toJson .language }}{{- $sep = "," -}}{{ end }} - - {{- if .measurements }}{{ $sep }}"measurements": {{ toJson .measurements }}{{- $sep = "," -}}{{ end }} - - {{- if .mip_opt_out }}{{ $sep }}"mip_opt_out": {{ toJson .mip_opt_out }}{{- $sep = "," -}}{{ end }} - - {{- if .mode }}{{ $sep }}"mode": {{ toJson .mode }}{{- $sep = "," -}}{{ end }} - - {{- if .multichannel }}{{ $sep }}"multichannel": {{ toJson .multichannel }}{{- $sep = "," -}}{{ end }} - - {{- if .numerals }}{{ $sep }}"numerals": {{ toJson .numerals }}{{- $sep = "," -}}{{ end }} - - {{- if .paragraphs }}{{ $sep }}"paragraphs": {{ toJson .paragraphs }}{{- $sep = "," -}}{{ end }} - - {{- if .profanity_filter }}{{ $sep }}"profanity_filter": {{ toJson .profanity_filter }}{{- $sep = "," -}}{{ end }} - - {{- if .punctuate }}{{ $sep }}"punctuate": {{ toJson .punctuate }}{{- $sep = "," -}}{{ end }} - - {{- if .redact }}{{ $sep }}"redact": {{ toJson .redact }}{{- $sep = "," -}}{{ end }} - - {{- if .replace }}{{ $sep }}"replace": {{ toJson .replace }}{{- $sep = "," -}}{{ end }} - - {{- if .search }}{{ $sep }}"search": {{ toJson .search }}{{- $sep = "," -}}{{ end }} - - {{- if .sentiment }}{{ $sep }}"sentiment": {{ toJson .sentiment }}{{- $sep = "," -}}{{ end }} - - {{- if .smart_format }}{{ $sep }}"smart_format": {{ toJson .smart_format }}{{- $sep = "," -}}{{ end }} - - {{- if .topics }}{{ $sep }}"topics": {{ toJson .topics }}{{- $sep = "," -}}{{ end }} - - {{- if .utt_split }}{{ $sep }}"utt_split": {{ toJson .utt_split }}{{- $sep = "," -}}{{ end }} - - {{- if .utterance_end_ms }}{{ $sep }}"utterance_end_ms": {{ toJson .utterance_end_ms }}{{- $sep = "," -}}{{ end }} - - {{- if .utterances }}{{ $sep }}"utterances": {{ toJson .utterances }}{{- $sep = "," -}}{{ end }} - - {{- if .vad_events }}{{ $sep }}"vad_events": {{ toJson .vad_events }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nova_3/methods/workers_ai_post_run_cf_deepgram_nova_3' - update: [] - delete: [] - replace: [] - deepseek_math_7b_instruct: - id: cloudflare.ai.deepseek_math_7b_instruct - name: deepseek_math_7b_instruct - title: Deepseek Math 7b Instruct - methods: - workers_ai_post_run_cf_deepseek_ai_deepseek_math_7b_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepseek-ai~1deepseek-math-7b-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/deepseek_math_7b_instruct/methods/workers_ai_post_run_cf_deepseek_ai_deepseek_math_7b_instruct' - update: [] - delete: [] - replace: [] - deepseek_r1_distill_qwen_32b: - id: cloudflare.ai.deepseek_r1_distill_qwen_32b - name: deepseek_r1_distill_qwen_32b - title: Deepseek R1 Distill Qwen 32b - methods: - workers_ai_post_run_cf_deepseek_ai_deepseek_r1_distill_qwen_32b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepseek-ai~1deepseek-r1-distill-qwen-32b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/deepseek_r1_distill_qwen_32b/methods/workers_ai_post_run_cf_deepseek_ai_deepseek_r1_distill_qwen_32b' - update: [] - delete: [] - replace: [] - sqlcoder_7b_2: - id: cloudflare.ai.sqlcoder_7b_2 - name: sqlcoder_7b_2 - title: Sqlcoder 7b 2 - methods: - workers_ai_post_run_cf_defog_sqlcoder_7b_2: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1defog~1sqlcoder-7b-2/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/sqlcoder_7b_2/methods/workers_ai_post_run_cf_defog_sqlcoder_7b_2' - update: [] - delete: [] - replace: [] - bart_large_cnn: - id: cloudflare.ai.bart_large_cnn - name: bart_large_cnn - title: Bart Large Cnn - methods: - workers_ai_post_run_cf_facebook_bart_large_cnn: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1bart-large-cnn/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bart_large_cnn/methods/workers_ai_post_run_cf_facebook_bart_large_cnn' - update: [] - delete: [] - replace: [] - nonomni_bart_large_cnn: - id: cloudflare.ai.nonomni_bart_large_cnn - name: nonomni_bart_large_cnn - title: Nonomni Bart Large Cnn - methods: - workers_ai_post_run_cf_facebook_nonomni_bart_large_cnn: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1nonomni-bart-large-cnn/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_bart_large_cnn/methods/workers_ai_post_run_cf_facebook_nonomni_bart_large_cnn' - update: [] - delete: [] - replace: [] - nonomni_detr_resnet_50: - id: cloudflare.ai.nonomni_detr_resnet_50 - name: nonomni_detr_resnet_50 - title: Nonomni Detr Resnet 50 - methods: - workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1nonomni-detr-resnet-50/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_detr_resnet_50/methods/workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50' - update: [] - delete: [] - replace: [] - una_cybertron_7b_v2_bf16: - id: cloudflare.ai.una_cybertron_7b_v2_bf16 - name: una_cybertron_7b_v2_bf16 - title: Una Cybertron 7b V2 Bf16 - methods: - workers_ai_post_run_cf_fblgit_una_cybertron_7b_v2_bf16: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1fblgit~1una-cybertron-7b-v2-bf16/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/una_cybertron_7b_v2_bf16/methods/workers_ai_post_run_cf_fblgit_una_cybertron_7b_v2_bf16' - update: [] - delete: [] - replace: [] - embeddinggemma_300m: - id: cloudflare.ai.embeddinggemma_300m - name: embeddinggemma_300m - title: Embeddinggemma 300m - methods: - workers_ai_post_run_cf_google_embeddinggemma_300m: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1embeddinggemma-300m/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/embeddinggemma_300m/methods/workers_ai_post_run_cf_google_embeddinggemma_300m' - update: [] - delete: [] - replace: [] - gemma_2b_it_lora: - id: cloudflare.ai.gemma_2b_it_lora - name: gemma_2b_it_lora - title: Gemma 2b It Lora - methods: - workers_ai_post_run_cf_google_gemma_2b_it_lora: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1gemma-2b-it-lora/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gemma_2b_it_lora/methods/workers_ai_post_run_cf_google_gemma_2b_it_lora' - update: [] - delete: [] - replace: [] - gemma_3_12b_it: - id: cloudflare.ai.gemma_3_12b_it - name: gemma_3_12b_it - title: Gemma 3 12b It - methods: - workers_ai_post_run_cf_google_gemma_3_12b_it: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1gemma-3-12b-it/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .guided_json }}{{ $sep }}"guided_json": {{ if eq (kindOf .guided_json) "string" }}{{ .guided_json }}{{ else }}{{ toJson .guided_json }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gemma_3_12b_it/methods/workers_ai_post_run_cf_google_gemma_3_12b_it' - update: [] - delete: [] - replace: [] - gemma_7b_it_lora: - id: cloudflare.ai.gemma_7b_it_lora - name: gemma_7b_it_lora - title: Gemma 7b It Lora - methods: - workers_ai_post_run_cf_google_gemma_7b_it_lora: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1gemma-7b-it-lora/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gemma_7b_it_lora/methods/workers_ai_post_run_cf_google_gemma_7b_it_lora' - update: [] - delete: [] - replace: [] - nonomni_embeddinggemma_300m: - id: cloudflare.ai.nonomni_embeddinggemma_300m - name: nonomni_embeddinggemma_300m - title: Nonomni Embeddinggemma 300m - methods: - workers_ai_post_run_cf_google_nonomni_embeddinggemma_300m: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1nonomni-embeddinggemma-300m/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_embeddinggemma_300m/methods/workers_ai_post_run_cf_google_nonomni_embeddinggemma_300m' - update: [] - delete: [] - replace: [] - distilbert_sst_2_int8: - id: cloudflare.ai.distilbert_sst_2_int8 - name: distilbert_sst_2_int8 - title: Distilbert Sst 2 Int8 - methods: - workers_ai_post_run_cf_huggingface_distilbert_sst_2_int8: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1huggingface~1distilbert-sst-2-int8/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/distilbert_sst_2_int8/methods/workers_ai_post_run_cf_huggingface_distilbert_sst_2_int8' - update: [] - delete: [] - replace: [] - nonomni_distilbert_sst_2_int8: - id: cloudflare.ai.nonomni_distilbert_sst_2_int8 - name: nonomni_distilbert_sst_2_int8 - title: Nonomni Distilbert Sst 2 Int8 - methods: - workers_ai_post_run_cf_huggingface_nonomni_distilbert_sst_2_int8: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1huggingface~1nonomni-distilbert-sst-2-int8/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_distilbert_sst_2_int8/methods/workers_ai_post_run_cf_huggingface_nonomni_distilbert_sst_2_int8' - update: [] - delete: [] - replace: [] - granite_4_0_h_micro: - id: cloudflare.ai.granite_4_0_h_micro - name: granite_4_0_h_micro - title: Granite 4 0 H Micro - methods: - workers_ai_post_run_cf_ibm_granite_granite_4_0_h_micro: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1ibm-granite~1granite-4.0-h-micro/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/granite_4_0_h_micro/methods/workers_ai_post_run_cf_ibm_granite_granite_4_0_h_micro' - update: [] - delete: [] - replace: [] - lucid_origin: - id: cloudflare.ai.lucid_origin - name: lucid_origin - title: Lucid Origin - methods: - workers_ai_post_run_cf_leonardo_lucid_origin: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1leonardo~1lucid-origin/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/lucid_origin/methods/workers_ai_post_run_cf_leonardo_lucid_origin' - update: [] - delete: [] - replace: [] - phoenix_1_0: - id: cloudflare.ai.phoenix_1_0 - name: phoenix_1_0 - title: Phoenix 1 0 - methods: - workers_ai_post_run_cf_leonardo_phoenix_1_0: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1leonardo~1phoenix-1.0/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/phoenix_1_0/methods/workers_ai_post_run_cf_leonardo_phoenix_1_0' - update: [] - delete: [] - replace: [] - dreamshaper_8_lcm: - id: cloudflare.ai.dreamshaper_8_lcm - name: dreamshaper_8_lcm - title: Dreamshaper 8 Lcm - methods: - workers_ai_post_run_cf_lykon_dreamshaper_8_lcm: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1lykon~1dreamshaper-8-lcm/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - - {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - - {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} - - {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/dreamshaper_8_lcm/methods/workers_ai_post_run_cf_lykon_dreamshaper_8_lcm' - update: [] - delete: [] - replace: [] - llama_2_7b_chat_hf_lora: - id: cloudflare.ai.llama_2_7b_chat_hf_lora - name: llama_2_7b_chat_hf_lora - title: Llama 2 7b Chat Hf Lora - methods: - workers_ai_post_run_cf_meta_llama_llama_2_7b_chat_hf_lora: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta-llama~1llama-2-7b-chat-hf-lora/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_2_7b_chat_hf_lora/methods/workers_ai_post_run_cf_meta_llama_llama_2_7b_chat_hf_lora' - update: [] - delete: [] - replace: [] - llama_2_7b_chat_fp16: - id: cloudflare.ai.llama_2_7b_chat_fp16 - name: llama_2_7b_chat_fp16 - title: Llama 2 7b Chat Fp16 - methods: - workers_ai_post_run_cf_meta_llama_2_7b_chat_fp16: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-2-7b-chat-fp16/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_2_7b_chat_fp16/methods/workers_ai_post_run_cf_meta_llama_2_7b_chat_fp16' - update: [] - delete: [] - replace: [] - llama_2_7b_chat_int8: - id: cloudflare.ai.llama_2_7b_chat_int8 - name: llama_2_7b_chat_int8 - title: Llama 2 7b Chat Int8 - methods: - workers_ai_post_run_cf_meta_llama_2_7b_chat_int8: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-2-7b-chat-int8/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_2_7b_chat_int8/methods/workers_ai_post_run_cf_meta_llama_2_7b_chat_int8' - update: [] - delete: [] - replace: [] - llama_3_8b_instruct: - id: cloudflare.ai.llama_3_8b_instruct - name: llama_3_8b_instruct - title: Llama 3 8b Instruct - methods: - workers_ai_post_run_cf_meta_llama_3_8b_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3-8b-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_8b_instruct/methods/workers_ai_post_run_cf_meta_llama_3_8b_instruct' - update: [] - delete: [] - replace: [] - llama_3_8b_instruct_awq: - id: cloudflare.ai.llama_3_8b_instruct_awq - name: llama_3_8b_instruct_awq - title: Llama 3 8b Instruct Awq - methods: - workers_ai_post_run_cf_meta_llama_3_8b_instruct_awq: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3-8b-instruct-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_8b_instruct_awq/methods/workers_ai_post_run_cf_meta_llama_3_8b_instruct_awq' - update: [] - delete: [] - replace: [] - llama_3_1_70b_instruct_fp8_fast: - id: cloudflare.ai.llama_3_1_70b_instruct_fp8_fast - name: llama_3_1_70b_instruct_fp8_fast - title: Llama 3 1 70b Instruct Fp8 Fast - methods: - workers_ai_post_run_cf_meta_llama_3_1_70b_instruct_fp8_fast: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-70b-instruct-fp8-fast/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_1_70b_instruct_fp8_fast/methods/workers_ai_post_run_cf_meta_llama_3_1_70b_instruct_fp8_fast' - update: [] - delete: [] - replace: [] - llama_3_1_8b_instruct_awq: - id: cloudflare.ai.llama_3_1_8b_instruct_awq - name: llama_3_1_8b_instruct_awq - title: Llama 3 1 8b Instruct Awq - methods: - workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_awq: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-8b-instruct-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_1_8b_instruct_awq/methods/workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_awq' - update: [] - delete: [] - replace: [] - llama_3_1_8b_instruct_fp8: - id: cloudflare.ai.llama_3_1_8b_instruct_fp8 - name: llama_3_1_8b_instruct_fp8 - title: Llama 3 1 8b Instruct Fp8 - methods: - workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-8b-instruct-fp8/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_1_8b_instruct_fp8/methods/workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8' - update: [] - delete: [] - replace: [] - llama_3_1_8b_instruct_fp8_fast: - id: cloudflare.ai.llama_3_1_8b_instruct_fp8_fast - name: llama_3_1_8b_instruct_fp8_fast - title: Llama 3 1 8b Instruct Fp8 Fast - methods: - workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8_fast: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-8b-instruct-fp8-fast/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_1_8b_instruct_fp8_fast/methods/workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8_fast' - update: [] - delete: [] - replace: [] - llama_3_2_11b_vision_instruct: - id: cloudflare.ai.llama_3_2_11b_vision_instruct - name: llama_3_2_11b_vision_instruct - title: Llama 3 2 11b Vision Instruct - methods: - workers_ai_post_run_cf_meta_llama_3_2_11b_vision_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.2-11b-vision-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_2_11b_vision_instruct/methods/workers_ai_post_run_cf_meta_llama_3_2_11b_vision_instruct' - update: [] - delete: [] - replace: [] - llama_3_2_1b_instruct: - id: cloudflare.ai.llama_3_2_1b_instruct - name: llama_3_2_1b_instruct - title: Llama 3 2 1b Instruct - methods: - workers_ai_post_run_cf_meta_llama_3_2_1b_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.2-1b-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_2_1b_instruct/methods/workers_ai_post_run_cf_meta_llama_3_2_1b_instruct' - update: [] - delete: [] - replace: [] - llama_3_2_3b_instruct: - id: cloudflare.ai.llama_3_2_3b_instruct - name: llama_3_2_3b_instruct - title: Llama 3 2 3b Instruct - methods: - workers_ai_post_run_cf_meta_llama_3_2_3b_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.2-3b-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_2_3b_instruct/methods/workers_ai_post_run_cf_meta_llama_3_2_3b_instruct' - update: [] - delete: [] - replace: [] - llama_3_3_70b_instruct_fp8_fast: - id: cloudflare.ai.llama_3_3_70b_instruct_fp8_fast - name: llama_3_3_70b_instruct_fp8_fast - title: Llama 3 3 70b Instruct Fp8 Fast - methods: - workers_ai_post_run_cf_meta_llama_3_3_70b_instruct_fp8_fast: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.3-70b-instruct-fp8-fast/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_3_3_70b_instruct_fp8_fast/methods/workers_ai_post_run_cf_meta_llama_3_3_70b_instruct_fp8_fast' - update: [] - delete: [] - replace: [] - llama_4_scout_17b_16e_instruct: - id: cloudflare.ai.llama_4_scout_17b_16e_instruct - name: llama_4_scout_17b_16e_instruct - title: Llama 4 Scout 17b 16e Instruct - methods: - workers_ai_post_run_cf_meta_llama_4_scout_17b_16e_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-4-scout-17b-16e-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .guided_json }}{{ $sep }}"guided_json": {{ if eq (kindOf .guided_json) "string" }}{{ .guided_json }}{{ else }}{{ toJson .guided_json }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_4_scout_17b_16e_instruct/methods/workers_ai_post_run_cf_meta_llama_4_scout_17b_16e_instruct' - update: [] - delete: [] - replace: [] - llama_guard_3_8b: - id: cloudflare.ai.llama_guard_3_8b - name: llama_guard_3_8b - title: Llama Guard 3 8b - methods: - workers_ai_post_run_cf_meta_llama_guard_3_8b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-guard-3-8b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_guard_3_8b/methods/workers_ai_post_run_cf_meta_llama_guard_3_8b' - update: [] - delete: [] - replace: [] - m2m100_1_2b: - id: cloudflare.ai.m2m100_1_2b - name: m2m100_1_2b - title: M2m100 1 2b - methods: - workers_ai_post_run_cf_meta_m2m100_1_2b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1m2m100-1.2b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .source_lang }}{{ $sep }}"source_lang": {{ toJson .source_lang }}{{- $sep = "," -}}{{ end }} - - {{- if .target_lang }}{{ $sep }}"target_lang": {{ toJson .target_lang }}{{- $sep = "," -}}{{ end }} - - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/m2m100_1_2b/methods/workers_ai_post_run_cf_meta_m2m100_1_2b' - update: [] - delete: [] - replace: [] - nonomni_resnet_50: - id: cloudflare.ai.nonomni_resnet_50 - name: nonomni_resnet_50 - title: Nonomni Resnet 50 - methods: - workers_ai_post_run_cf_microsoft_nonomni_resnet_50: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1nonomni-resnet-50/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nonomni_resnet_50/methods/workers_ai_post_run_cf_microsoft_nonomni_resnet_50' - update: [] - delete: [] - replace: [] - phi_2: - id: cloudflare.ai.phi_2 - name: phi_2 - title: Phi 2 - methods: - workers_ai_post_run_cf_microsoft_phi_2: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1phi-2/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/phi_2/methods/workers_ai_post_run_cf_microsoft_phi_2' - update: [] - delete: [] - replace: [] - resnet_50: - id: cloudflare.ai.resnet_50 - name: resnet_50 - title: Resnet 50 - methods: - workers_ai_post_run_cf_microsoft_resnet_50: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1resnet-50/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/resnet_50/methods/workers_ai_post_run_cf_microsoft_resnet_50' - update: [] - delete: [] - replace: [] - mistral_7b_instruct_v0_1: - id: cloudflare.ai.mistral_7b_instruct_v0_1 - name: mistral_7b_instruct_v0_1 - title: Mistral 7b Instruct V0 1 - methods: - workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_1: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1mistral~1mistral-7b-instruct-v0.1/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/mistral_7b_instruct_v0_1/methods/workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_1' - update: [] - delete: [] - replace: [] - mistral_7b_instruct_v0_2_lora: - id: cloudflare.ai.mistral_7b_instruct_v0_2_lora - name: mistral_7b_instruct_v0_2_lora - title: Mistral 7b Instruct V0 2 Lora - methods: - workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_2_lora: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1mistral~1mistral-7b-instruct-v0.2-lora/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/mistral_7b_instruct_v0_2_lora/methods/workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_2_lora' - update: [] - delete: [] - replace: [] - mistral_small_3_1_24b_instruct: - id: cloudflare.ai.mistral_small_3_1_24b_instruct - name: mistral_small_3_1_24b_instruct - title: Mistral Small 3 1 24b Instruct - methods: - workers_ai_post_run_cf_mistralai_mistral_small_3_1_24b_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1mistralai~1mistral-small-3.1-24b-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .guided_json }}{{ $sep }}"guided_json": {{ if eq (kindOf .guided_json) "string" }}{{ .guided_json }}{{ else }}{{ toJson .guided_json }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/mistral_small_3_1_24b_instruct/methods/workers_ai_post_run_cf_mistralai_mistral_small_3_1_24b_instruct' - update: [] - delete: [] - replace: [] - kimi_k2_5: - id: cloudflare.ai.kimi_k2_5 - name: kimi_k2_5 - title: Kimi K2 5 - methods: - workers_ai_post_run_cf_moonshotai_kimi_k2_5: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1moonshotai~1kimi-k2.5/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .chat_template_kwargs }}{{ $sep }}"chat_template_kwargs": {{ if eq (kindOf .chat_template_kwargs) "string" }}{{ .chat_template_kwargs }}{{ else }}{{ toJson .chat_template_kwargs }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .function_call }}{{ $sep }}"function_call": {{ toJson .function_call }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .logit_bias }}{{ $sep }}"logit_bias": {{ if eq (kindOf .logit_bias) "string" }}{{ .logit_bias }}{{ else }}{{ toJson .logit_bias }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .logprobs }}{{ $sep }}"logprobs": {{ toJson .logprobs }}{{- $sep = "," -}}{{ end }} - - {{- if .max_completion_tokens }}{{ $sep }}"max_completion_tokens": {{ toJson .max_completion_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .metadata }}{{ $sep }}"metadata": {{ if eq (kindOf .metadata) "string" }}{{ .metadata }}{{ else }}{{ toJson .metadata }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .modalities }}{{ $sep }}"modalities": {{ if eq (kindOf .modalities) "string" }}{{ .modalities }}{{ else }}{{ toJson .modalities }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .model }}{{ $sep }}"model": {{ toJson .model }}{{- $sep = "," -}}{{ end }} - - {{- if .n }}{{ $sep }}"n": {{ toJson .n }}{{- $sep = "," -}}{{ end }} - - {{- if .parallel_tool_calls }}{{ $sep }}"parallel_tool_calls": {{ toJson .parallel_tool_calls }}{{- $sep = "," -}}{{ end }} - - {{- if .prediction }}{{ $sep }}"prediction": {{ if eq (kindOf .prediction) "string" }}{{ .prediction }}{{ else }}{{ toJson .prediction }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .reasoning_effort }}{{ $sep }}"reasoning_effort": {{ toJson .reasoning_effort }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .service_tier }}{{ $sep }}"service_tier": {{ toJson .service_tier }}{{- $sep = "," -}}{{ end }} - - {{- if .stop }}{{ $sep }}"stop": {{ toJson .stop }}{{- $sep = "," -}}{{ end }} - - {{- if .store }}{{ $sep }}"store": {{ toJson .store }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .stream_options }}{{ $sep }}"stream_options": {{ if eq (kindOf .stream_options) "string" }}{{ .stream_options }}{{ else }}{{ toJson .stream_options }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .tool_choice }}{{ $sep }}"tool_choice": {{ toJson .tool_choice }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .top_logprobs }}{{ $sep }}"top_logprobs": {{ toJson .top_logprobs }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .user }}{{ $sep }}"user": {{ toJson .user }}{{- $sep = "," -}}{{ end }} - - {{- if .web_search_options }}{{ $sep }}"web_search_options": {{ if eq (kindOf .web_search_options) "string" }}{{ .web_search_options }}{{ else }}{{ toJson .web_search_options }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/kimi_k2_5/methods/workers_ai_post_run_cf_moonshotai_kimi_k2_5' - update: [] - delete: [] - replace: [] - melotts: - id: cloudflare.ai.melotts - name: melotts - title: Melotts - methods: - workers_ai_post_run_cf_myshell_ai_melotts: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1myshell-ai~1melotts/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/melotts/methods/workers_ai_post_run_cf_myshell_ai_melotts' - update: [] - delete: [] - replace: [] - nemotron_3_120b_a12b: - id: cloudflare.ai.nemotron_3_120b_a12b - name: nemotron_3_120b_a12b - title: Nemotron 3 120b A12b - methods: - workers_ai_post_run_cf_nvidia_nemotron_3_120b_a12b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1nvidia~1nemotron-3-120b-a12b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .chat_template_kwargs }}{{ $sep }}"chat_template_kwargs": {{ if eq (kindOf .chat_template_kwargs) "string" }}{{ .chat_template_kwargs }}{{ else }}{{ toJson .chat_template_kwargs }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .function_call }}{{ $sep }}"function_call": {{ toJson .function_call }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .logit_bias }}{{ $sep }}"logit_bias": {{ if eq (kindOf .logit_bias) "string" }}{{ .logit_bias }}{{ else }}{{ toJson .logit_bias }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .logprobs }}{{ $sep }}"logprobs": {{ toJson .logprobs }}{{- $sep = "," -}}{{ end }} - - {{- if .max_completion_tokens }}{{ $sep }}"max_completion_tokens": {{ toJson .max_completion_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .metadata }}{{ $sep }}"metadata": {{ if eq (kindOf .metadata) "string" }}{{ .metadata }}{{ else }}{{ toJson .metadata }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .modalities }}{{ $sep }}"modalities": {{ if eq (kindOf .modalities) "string" }}{{ .modalities }}{{ else }}{{ toJson .modalities }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .model }}{{ $sep }}"model": {{ toJson .model }}{{- $sep = "," -}}{{ end }} - - {{- if .n }}{{ $sep }}"n": {{ toJson .n }}{{- $sep = "," -}}{{ end }} - - {{- if .parallel_tool_calls }}{{ $sep }}"parallel_tool_calls": {{ toJson .parallel_tool_calls }}{{- $sep = "," -}}{{ end }} - - {{- if .prediction }}{{ $sep }}"prediction": {{ if eq (kindOf .prediction) "string" }}{{ .prediction }}{{ else }}{{ toJson .prediction }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .reasoning_effort }}{{ $sep }}"reasoning_effort": {{ toJson .reasoning_effort }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .service_tier }}{{ $sep }}"service_tier": {{ toJson .service_tier }}{{- $sep = "," -}}{{ end }} - - {{- if .stop }}{{ $sep }}"stop": {{ toJson .stop }}{{- $sep = "," -}}{{ end }} - - {{- if .store }}{{ $sep }}"store": {{ toJson .store }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .stream_options }}{{ $sep }}"stream_options": {{ if eq (kindOf .stream_options) "string" }}{{ .stream_options }}{{ else }}{{ toJson .stream_options }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .tool_choice }}{{ $sep }}"tool_choice": {{ toJson .tool_choice }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .top_logprobs }}{{ $sep }}"top_logprobs": {{ toJson .top_logprobs }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .user }}{{ $sep }}"user": {{ toJson .user }}{{- $sep = "," -}}{{ end }} - - {{- if .web_search_options }}{{ $sep }}"web_search_options": {{ if eq (kindOf .web_search_options) "string" }}{{ .web_search_options }}{{ else }}{{ toJson .web_search_options }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/nemotron_3_120b_a12b/methods/workers_ai_post_run_cf_nvidia_nemotron_3_120b_a12b' - update: [] - delete: [] - replace: [] - gpt_oss_120b: - id: cloudflare.ai.gpt_oss_120b - name: gpt_oss_120b - title: Gpt Oss 120b - methods: - workers_ai_post_run_cf_openai_gpt_oss_120b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1gpt-oss-120b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .input }}{{ $sep }}"input": {{ toJson .input }}{{- $sep = "," -}}{{ end }} - - {{- if .reasoning }}{{ $sep }}"reasoning": {{ if eq (kindOf .reasoning) "string" }}{{ .reasoning }}{{ else }}{{ toJson .reasoning }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gpt_oss_120b/methods/workers_ai_post_run_cf_openai_gpt_oss_120b' - update: [] - delete: [] - replace: [] - gpt_oss_20b: - id: cloudflare.ai.gpt_oss_20b - name: gpt_oss_20b - title: Gpt Oss 20b - methods: - workers_ai_post_run_cf_openai_gpt_oss_20b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1gpt-oss-20b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .input }}{{ $sep }}"input": {{ toJson .input }}{{- $sep = "," -}}{{ end }} - - {{- if .reasoning }}{{ $sep }}"reasoning": {{ if eq (kindOf .reasoning) "string" }}{{ .reasoning }}{{ else }}{{ toJson .reasoning }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gpt_oss_20b/methods/workers_ai_post_run_cf_openai_gpt_oss_20b' - update: [] - delete: [] - replace: [] - whisper: - id: cloudflare.ai.whisper - name: whisper - title: Whisper - methods: - workers_ai_post_run_cf_openai_whisper: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/whisper/methods/workers_ai_post_run_cf_openai_whisper' - update: [] - delete: [] - replace: [] - whisper_large_v3_turbo: - id: cloudflare.ai.whisper_large_v3_turbo - name: whisper_large_v3_turbo - title: Whisper Large V3 Turbo - methods: - workers_ai_post_run_cf_openai_whisper_large_v3_turbo: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper-large-v3-turbo/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/whisper_large_v3_turbo/methods/workers_ai_post_run_cf_openai_whisper_large_v3_turbo' - update: [] - delete: [] - replace: [] - whisper_tiny_en: - id: cloudflare.ai.whisper_tiny_en - name: whisper_tiny_en - title: Whisper Tiny En - methods: - workers_ai_post_run_cf_openai_whisper_tiny_en: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper-tiny-en/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/whisper_tiny_en/methods/workers_ai_post_run_cf_openai_whisper_tiny_en' - update: [] - delete: [] - replace: [] - openchat_3_5_0106: - id: cloudflare.ai.openchat_3_5_0106 - name: openchat_3_5_0106 - title: Openchat 3 5 0106 - methods: - workers_ai_post_run_cf_openchat_openchat_3_5_0106: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openchat~1openchat-3.5-0106/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/openchat_3_5_0106/methods/workers_ai_post_run_cf_openchat_openchat_3_5_0106' - update: [] - delete: [] - replace: [] - plamo_embedding_1b: - id: cloudflare.ai.plamo_embedding_1b - name: plamo_embedding_1b - title: Plamo Embedding 1b - methods: - workers_ai_post_run_cf_pfnet_plamo_embedding_1b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1pfnet~1plamo-embedding-1b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/plamo_embedding_1b/methods/workers_ai_post_run_cf_pfnet_plamo_embedding_1b' - update: [] - delete: [] - replace: [] - qwen1_5_0_5b_chat: - id: cloudflare.ai.qwen1_5_0_5b_chat - name: qwen1_5_0_5b_chat - title: Qwen1 5 0 5b Chat - methods: - workers_ai_post_run_cf_qwen_qwen1_5_0_5b_chat: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-0.5b-chat/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen1_5_0_5b_chat/methods/workers_ai_post_run_cf_qwen_qwen1_5_0_5b_chat' - update: [] - delete: [] - replace: [] - qwen1_5_1_8b_chat: - id: cloudflare.ai.qwen1_5_1_8b_chat - name: qwen1_5_1_8b_chat - title: Qwen1 5 1 8b Chat - methods: - workers_ai_post_run_cf_qwen_qwen1_5_1_8b_chat: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-1.8b-chat/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen1_5_1_8b_chat/methods/workers_ai_post_run_cf_qwen_qwen1_5_1_8b_chat' - update: [] - delete: [] - replace: [] - qwen1_5_14b_chat_awq: - id: cloudflare.ai.qwen1_5_14b_chat_awq - name: qwen1_5_14b_chat_awq - title: Qwen1 5 14b Chat Awq - methods: - workers_ai_post_run_cf_qwen_qwen1_5_14b_chat_awq: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-14b-chat-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen1_5_14b_chat_awq/methods/workers_ai_post_run_cf_qwen_qwen1_5_14b_chat_awq' - update: [] - delete: [] - replace: [] - qwen1_5_7b_chat_awq: - id: cloudflare.ai.qwen1_5_7b_chat_awq - name: qwen1_5_7b_chat_awq - title: Qwen1 5 7b Chat Awq - methods: - workers_ai_post_run_cf_qwen_qwen1_5_7b_chat_awq: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-7b-chat-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen1_5_7b_chat_awq/methods/workers_ai_post_run_cf_qwen_qwen1_5_7b_chat_awq' - update: [] - delete: [] - replace: [] - qwen2_5_coder_32b_instruct: - id: cloudflare.ai.qwen2_5_coder_32b_instruct - name: qwen2_5_coder_32b_instruct - title: Qwen2 5 Coder 32b Instruct - methods: - workers_ai_post_run_cf_qwen_qwen2_5_coder_32b_instruct: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen2.5-coder-32b-instruct/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen2_5_coder_32b_instruct/methods/workers_ai_post_run_cf_qwen_qwen2_5_coder_32b_instruct' - update: [] - delete: [] - replace: [] - qwen3_30b_a3b_fp8: - id: cloudflare.ai.qwen3_30b_a3b_fp8 - name: qwen3_30b_a3b_fp8 - title: Qwen3 30b A3b Fp8 - methods: - workers_ai_post_run_cf_qwen_qwen3_30b_a3b_fp8: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen3-30b-a3b-fp8/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen3_30b_a3b_fp8/methods/workers_ai_post_run_cf_qwen_qwen3_30b_a3b_fp8' - update: [] - delete: [] - replace: [] - qwen3_embedding_0_6b: - id: cloudflare.ai.qwen3_embedding_0_6b - name: qwen3_embedding_0_6b - title: Qwen3 Embedding 0 6b + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + authors: + id: cloudflare.ai.authors + name: authors + title: Authors methods: - workers_ai_post_run_cf_qwen_qwen3_embedding_0_6b: - config: - requestBodyTranslate: - algorithm: naive + list: operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen3-embedding-0.6b/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1authors~1search/get' response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{{ range $i, $v := .result }}{{ if $i }},{{ end }}{"author": {{ toJson $v }}}{{ end }}]' + type: golang_template_json_v0.3.0 sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwen3_embedding_0_6b/methods/workers_ai_post_run_cf_qwen_qwen3_embedding_0_6b' + select: + - $ref: '#/components/x-stackQL-resources/authors/methods/list' + insert: [] update: [] delete: [] replace: [] - qwq_32b: - id: cloudflare.ai.qwq_32b - name: qwq_32b - title: Qwq 32b + finetunes: + id: cloudflare.ai.finetunes + name: finetunes + title: Finetunes methods: - workers_ai_post_run_cf_qwen_qwq_32b: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwq-32b/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes/post' response: mediaType: application/json openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .guided_json }}{{ $sep }}"guided_json": {{ if eq (kindOf .guided_json) "string" }}{{ .guided_json }}{{ else }}{{ toJson .guided_json }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/qwq_32b/methods/workers_ai_post_run_cf_qwen_qwq_32b' - update: [] - delete: [] - replace: [] - stable_diffusion_v1_5_img2img: - id: cloudflare.ai.stable_diffusion_v1_5_img2img - name: stable_diffusion_v1_5_img2img - title: Stable Diffusion V1 5 Img2img - methods: - workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_img2img: + upload_asset: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1runwayml~1stable-diffusion-v1-5-img2img/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes~1{finetune_id}~1finetune-assets/post' response: mediaType: application/json openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - - {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - - {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} - - {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} - - } - - ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/finetunes/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/stable_diffusion_v1_5_img2img/methods/workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_img2img' + - $ref: '#/components/x-stackQL-resources/finetunes/methods/create' update: [] delete: [] replace: [] - stable_diffusion_v1_5_inpainting: - id: cloudflare.ai.stable_diffusion_v1_5_inpainting - name: stable_diffusion_v1_5_inpainting - title: Stable Diffusion V1 5 Inpainting + public: + id: cloudflare.ai.public + name: public + title: Public methods: - workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_inpainting: - config: - requestBodyTranslate: - algorithm: naive + list: operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1runwayml~1stable-diffusion-v1-5-inpainting/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes~1public/get' response: mediaType: application/json openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - - {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - - {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} - - {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} - - } - - ' + objectKey: $.result sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/stable_diffusion_v1_5_inpainting/methods/workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_inpainting' + select: + - $ref: '#/components/x-stackQL-resources/public/methods/list' + insert: [] update: [] delete: [] replace: [] - stable_diffusion_xl_base_1_0: - id: cloudflare.ai.stable_diffusion_xl_base_1_0 - name: stable_diffusion_xl_base_1_0 - title: Stable Diffusion Xl Base 1 0 + schema: + id: cloudflare.ai.schema + name: schema + title: Schema methods: - workers_ai_post_run_cf_stabilityai_stable_diffusion_xl_base_1_0: - config: - requestBodyTranslate: - algorithm: naive + list: operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1stabilityai~1stable-diffusion-xl-base-1.0/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1models~1schema/get' response: mediaType: application/json openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - - {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - - {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} - - {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} - - } - - ' + objectKey: $.result sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/stable_diffusion_xl_base_1_0/methods/workers_ai_post_run_cf_stabilityai_stable_diffusion_xl_base_1_0' + select: + - $ref: '#/components/x-stackQL-resources/schema/methods/list' + insert: [] update: [] delete: [] replace: [] - discolm_german_7b_v1_awq: - id: cloudflare.ai.discolm_german_7b_v1_awq - name: discolm_german_7b_v1_awq - title: Discolm German 7b V1 Awq + models: + id: cloudflare.ai.models + name: models + title: Models methods: - workers_ai_post_run_cf_thebloke_discolm_german_7b_v1_awq: - config: - requestBodyTranslate: - algorithm: naive + list: operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1thebloke~1discolm-german-7b-v1-awq/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1models~1search/get' response: mediaType: application/json openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' + objectKey: $.result sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/discolm_german_7b_v1_awq/methods/workers_ai_post_run_cf_thebloke_discolm_german_7b_v1_awq' + select: + - $ref: '#/components/x-stackQL-resources/models/methods/list' + insert: [] update: [] delete: [] replace: [] - falcon_7b_instruct: - id: cloudflare.ai.falcon_7b_instruct - name: falcon_7b_instruct - title: Falcon 7b Instruct + run: + id: cloudflare.ai.run + name: run + title: Run methods: - workers_ai_post_run_cf_tiiuae_falcon_7b_instruct: - config: - requestBodyTranslate: - algorithm: naive + nonomni_detr_resnet_50: operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1tiiuae~1falcon-7b-instruct/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1nonomni-detr-resnet-50/post' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersAiPostRunCfFacebookNonomniDetrResnet50Body' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' response: mediaType: application/json openAPIDocKey: '200' + nonomni_resnet_50: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1nonomni-resnet-50/post' request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersAiPostRunCfMicrosoftNonomniResnet50Body' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' + response: mediaType: application/json + openAPIDocKey: '200' + resnet_50: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1resnet-50/post' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersAiPostRunCfMicrosoftResnet50Body' transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/falcon_7b_instruct/methods/workers_ai_post_run_cf_tiiuae_falcon_7b_instruct' - update: [] - delete: [] - replace: [] - tinyllama_1_1b_chat_v1_0: - id: cloudflare.ai.tinyllama_1_1b_chat_v1_0 - name: tinyllama_1_1b_chat_v1_0 - title: Tinyllama 1 1b Chat V1 0 - methods: - workers_ai_post_run_cf_tinyllama_tinyllama_1_1b_chat_v1_0: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' + response: + mediaType: application/json + openAPIDocKey: '200' + whisper: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper/post' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersAiPostRunCfOpenaiWhisperBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' + response: + mediaType: application/json + openAPIDocKey: '200' + whisper_tiny_en: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper-tiny-en/post' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersAiPostRunCfOpenaiWhisperTinyEnBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' + response: + mediaType: application/json + openAPIDocKey: '200' + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1tinyllama~1tinyllama-1.1b-chat-v1.0/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.result request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiRunInput' transform: type: golang_template_json_v0.3.0 body: '{ @@ -27096,56 +5313,24 @@ components: {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - } + {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/tinyllama_1_1b_chat_v1_0/methods/workers_ai_post_run_cf_tinyllama_tinyllama_1_1b_chat_v1_0' - update: [] - delete: [] - replace: [] - glm_4_7_flash: - id: cloudflare.ai.glm_4_7_flash - name: glm_4_7_flash - title: Glm 4 7 Flash - methods: - workers_ai_post_run_cf_zai_org_glm_4_7_flash: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1zai-org~1glm-4.7-flash/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .guided_json }}{{ $sep }}"guided_json": {{ if eq (kindOf .guided_json) "string" }}{{ .guided_json }}{{ else }}{{ toJson .guided_json }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .chat_template_kwargs }}{{ $sep }}"chat_template_kwargs": {{ if eq (kindOf .chat_template_kwargs) "string" }}{{ .chat_template_kwargs }}{{ else }}{{ toJson .chat_template_kwargs }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - {{- if .function_call }}{{ $sep }}"function_call": {{ toJson .function_call }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .logit_bias }}{{ $sep }}"logit_bias": {{ if eq (kindOf .logit_bias) "string" }}{{ .logit_bias }}{{ else }}{{ toJson .logit_bias }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .logprobs }}{{ $sep }}"logprobs": {{ toJson .logprobs }}{{- $sep = "," -}}{{ end }} {{- if .max_completion_tokens }}{{ $sep }}"max_completion_tokens": {{ toJson .max_completion_tokens }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - {{- if .metadata }}{{ $sep }}"metadata": {{ if eq (kindOf .metadata) "string" }}{{ .metadata }}{{ else }}{{ toJson .metadata }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .modalities }}{{ $sep }}"modalities": {{ if eq (kindOf .modalities) "string" }}{{ .modalities }}{{ else }}{{ toJson .modalities }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -27158,319 +5343,222 @@ components: {{- if .prediction }}{{ $sep }}"prediction": {{ if eq (kindOf .prediction) "string" }}{{ .prediction }}{{ else }}{{ toJson .prediction }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - {{- if .reasoning_effort }}{{ $sep }}"reasoning_effort": {{ toJson .reasoning_effort }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - {{- if .service_tier }}{{ $sep }}"service_tier": {{ toJson .service_tier }}{{- $sep = "," -}}{{ end }} {{- if .stop }}{{ $sep }}"stop": {{ toJson .stop }}{{- $sep = "," -}}{{ end }} {{- if .store }}{{ $sep }}"store": {{ toJson .store }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - {{- if .stream_options }}{{ $sep }}"stream_options": {{ if eq (kindOf .stream_options) "string" }}{{ .stream_options }}{{ else }}{{ toJson .stream_options }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - {{- if .tool_choice }}{{ $sep }}"tool_choice": {{ toJson .tool_choice }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .top_logprobs }}{{ $sep }}"top_logprobs": {{ toJson .top_logprobs }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - {{- if .user }}{{ $sep }}"user": {{ toJson .user }}{{- $sep = "," -}}{{ end }} {{- if .web_search_options }}{{ $sep }}"web_search_options": {{ if eq (kindOf .web_search_options) "string" }}{{ .web_search_options }}{{ else }}{{ toJson .web_search_options }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .input }}{{ $sep }}"input": {{ toJson .input }}{{- $sep = "," -}}{{ end }} - } + {{- if .reasoning }}{{ $sep }}"reasoning": {{ if eq (kindOf .reasoning) "string" }}{{ .reasoning }}{{ else }}{{ toJson .reasoning }}{{ end }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/glm_4_7_flash/methods/workers_ai_post_run_cf_zai_org_glm_4_7_flash' - update: [] - delete: [] - replace: [] - gemma_7b_it: - id: cloudflare.ai.gemma_7b_it - name: gemma_7b_it - title: Gemma 7b It - methods: - workers_ai_post_run_hf_google_gemma_7b_it: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1google~1gemma-7b-it/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .contexts }}{{ $sep }}"contexts": {{ if eq (kindOf .contexts) "string" }}{{ .contexts }}{{ else }}{{ toJson .contexts }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .truncate_inputs }}{{ $sep }}"truncate_inputs": {{ toJson .truncate_inputs }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .documents }}{{ $sep }}"documents": {{ toJson .documents }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .instruction }}{{ $sep }}"instruction": {{ toJson .instruction }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .queries }}{{ $sep }}"queries": {{ toJson .queries }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .eager_eot_threshold }}{{ $sep }}"eager_eot_threshold": {{ toJson .eager_eot_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .encoding }}{{ $sep }}"encoding": {{ toJson .encoding }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .eot_threshold }}{{ $sep }}"eot_threshold": {{ toJson .eot_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .eot_timeout_ms }}{{ $sep }}"eot_timeout_ms": {{ toJson .eot_timeout_ms }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .keyterm }}{{ $sep }}"keyterm": {{ toJson .keyterm }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .mip_opt_out }}{{ $sep }}"mip_opt_out": {{ toJson .mip_opt_out }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .sample_rate }}{{ $sep }}"sample_rate": {{ toJson .sample_rate }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .tag }}{{ $sep }}"tag": {{ toJson .tag }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .channels }}{{ $sep }}"channels": {{ toJson .channels }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .custom_intent }}{{ $sep }}"custom_intent": {{ toJson .custom_intent }}{{- $sep = "," -}}{{ end }} - } + {{- if .custom_intent_mode }}{{ $sep }}"custom_intent_mode": {{ toJson .custom_intent_mode }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/gemma_7b_it/methods/workers_ai_post_run_hf_google_gemma_7b_it' - update: [] - delete: [] - replace: [] - mistral_7b_instruct_v0_2: - id: cloudflare.ai.mistral_7b_instruct_v0_2 - name: mistral_7b_instruct_v0_2 - title: Mistral 7b Instruct V0 2 - methods: - workers_ai_post_run_hf_mistral_mistral_7b_instruct_v0_2: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1mistral~1mistral-7b-instruct-v0.2/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .custom_topic }}{{ $sep }}"custom_topic": {{ toJson .custom_topic }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .custom_topic_mode }}{{ $sep }}"custom_topic_mode": {{ toJson .custom_topic_mode }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .detect_entities }}{{ $sep }}"detect_entities": {{ toJson .detect_entities }}{{- $sep = "," -}}{{ end }} - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .detect_language }}{{ $sep }}"detect_language": {{ toJson .detect_language }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .diarize }}{{ $sep }}"diarize": {{ toJson .diarize }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .dictation }}{{ $sep }}"dictation": {{ toJson .dictation }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .endpointing }}{{ $sep }}"endpointing": {{ toJson .endpointing }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .extra }}{{ $sep }}"extra": {{ toJson .extra }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .filler_words }}{{ $sep }}"filler_words": {{ toJson .filler_words }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .interim_results }}{{ $sep }}"interim_results": {{ toJson .interim_results }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .keywords }}{{ $sep }}"keywords": {{ toJson .keywords }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .language }}{{ $sep }}"language": {{ toJson .language }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .measurements }}{{ $sep }}"measurements": {{ toJson .measurements }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .mode }}{{ $sep }}"mode": {{ toJson .mode }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .multichannel }}{{ $sep }}"multichannel": {{ toJson .multichannel }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .numerals }}{{ $sep }}"numerals": {{ toJson .numerals }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .paragraphs }}{{ $sep }}"paragraphs": {{ toJson .paragraphs }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .profanity_filter }}{{ $sep }}"profanity_filter": {{ toJson .profanity_filter }}{{- $sep = "," -}}{{ end }} - } + {{- if .punctuate }}{{ $sep }}"punctuate": {{ toJson .punctuate }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/mistral_7b_instruct_v0_2/methods/workers_ai_post_run_hf_mistral_mistral_7b_instruct_v0_2' - update: [] - delete: [] - replace: [] - starling_lm_7b_beta: - id: cloudflare.ai.starling_lm_7b_beta - name: starling_lm_7b_beta - title: Starling Lm 7b Beta - methods: - workers_ai_post_run_hf_nexusflow_starling_lm_7b_beta: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1nexusflow~1starling-lm-7b-beta/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .redact }}{{ $sep }}"redact": {{ toJson .redact }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .replace }}{{ $sep }}"replace": {{ toJson .replace }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .search }}{{ $sep }}"search": {{ toJson .search }}{{- $sep = "," -}}{{ end }} - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .sentiment }}{{ $sep }}"sentiment": {{ toJson .sentiment }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .smart_format }}{{ $sep }}"smart_format": {{ toJson .smart_format }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .topics }}{{ $sep }}"topics": {{ toJson .topics }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .utt_split }}{{ $sep }}"utt_split": {{ toJson .utt_split }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .utterance_end_ms }}{{ $sep }}"utterance_end_ms": {{ toJson .utterance_end_ms }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .utterances }}{{ $sep }}"utterances": {{ toJson .utterances }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .vad_events }}{{ $sep }}"vad_events": {{ toJson .vad_events }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .beam_size }}{{ $sep }}"beam_size": {{ toJson .beam_size }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .compression_ratio_threshold }}{{ $sep }}"compression_ratio_threshold": {{ toJson .compression_ratio_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .condition_on_previous_text }}{{ $sep }}"condition_on_previous_text": {{ toJson .condition_on_previous_text }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .hallucination_silence_threshold }}{{ $sep }}"hallucination_silence_threshold": {{ toJson .hallucination_silence_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .initial_prompt }}{{ $sep }}"initial_prompt": {{ toJson .initial_prompt }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .log_prob_threshold }}{{ $sep }}"log_prob_threshold": {{ toJson .log_prob_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .no_speech_threshold }}{{ $sep }}"no_speech_threshold": {{ toJson .no_speech_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .prefix }}{{ $sep }}"prefix": {{ toJson .prefix }}{{- $sep = "," -}}{{ end }} - } + {{- if .task }}{{ $sep }}"task": {{ toJson .task }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/starling_lm_7b_beta/methods/workers_ai_post_run_hf_nexusflow_starling_lm_7b_beta' - update: [] - delete: [] - replace: [] - hermes_2_pro_mistral_7b: - id: cloudflare.ai.hermes_2_pro_mistral_7b - name: hermes_2_pro_mistral_7b - title: Hermes 2 Pro Mistral 7b - methods: - workers_ai_post_run_hf_nousresearch_hermes_2_pro_mistral_7b: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1nousresearch~1hermes-2-pro-mistral-7b/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .vad_filter }}{{ $sep }}"vad_filter": {{ toJson .vad_filter }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .target_language }}{{ $sep }}"target_language": {{ toJson .target_language }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .source_lang }}{{ $sep }}"source_lang": {{ toJson .source_lang }}{{- $sep = "," -}}{{ end }} - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .target_lang }}{{ $sep }}"target_lang": {{ toJson .target_lang }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .input_text }}{{ $sep }}"input_text": {{ toJson .input_text }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .max_length }}{{ $sep }}"max_length": {{ toJson .max_length }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .steps }}{{ $sep }}"steps": {{ toJson .steps }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .multipart }}{{ $sep }}"multipart": {{ if eq (kindOf .multipart) "string" }}{{ .multipart }}{{ else }}{{ toJson .multipart }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .bit_rate }}{{ $sep }}"bit_rate": {{ toJson .bit_rate }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .container }}{{ $sep }}"container": {{ toJson .container }}{{- $sep = "," -}}{{ end }} + + {{- if .speaker }}{{ $sep }}"speaker": {{ toJson .speaker }}{{- $sep = "," -}}{{ end }} + + {{- if .lang }}{{ $sep }}"lang": {{ toJson .lang }}{{- $sep = "," -}}{{ end }} } ' sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/hermes_2_pro_mistral_7b/methods/workers_ai_post_run_hf_nousresearch_hermes_2_pro_mistral_7b' + select: + - $ref: '#/components/x-stackQL-resources/run/methods/run' + insert: [] + update: [] + delete: [] + replace: [] + tasks: + id: cloudflare.ai.tasks + name: tasks + title: Tasks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1tasks~1search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tasks/methods/list' + insert: [] update: [] delete: [] replace: [] - deepseek_coder_6_7b_base_awq: - id: cloudflare.ai.deepseek_coder_6_7b_base_awq - name: deepseek_coder_6_7b_base_awq - title: Deepseek Coder 6 7b Base Awq + to_markdown: + id: cloudflare.ai.to_markdown + name: to_markdown + title: To Markdown methods: - workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_base_awq: + convert: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1deepseek-coder-6.7b-base-awq/post' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1tomarkdown/post' response: mediaType: application/json openAPIDocKey: '200' @@ -27482,59 +5570,48 @@ components: {{- $sep := "" -}} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .files }}{{ $sep }}"files": {{ if eq (kindOf .files) "string" }}{{ .files }}{{ else }}{{ toJson .files }}{{ end }}{{- $sep = "," -}}{{ end }} } ' sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/deepseek_coder_6_7b_base_awq/methods/workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_base_awq' + select: + - $ref: '#/components/x-stackQL-resources/to_markdown/methods/convert' + insert: [] + update: [] + delete: [] + replace: [] + to_markdown_supported: + id: cloudflare.ai.to_markdown_supported + name: to_markdown_supported + title: To Markdown Supported + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1tomarkdown~1supported/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/to_markdown_supported/methods/list' + insert: [] update: [] delete: [] replace: [] - deepseek_coder_6_7b_instruct_awq: - id: cloudflare.ai.deepseek_coder_6_7b_instruct_awq - name: deepseek_coder_6_7b_instruct_awq - title: Deepseek Coder 6 7b Instruct Awq + ai_search: + id: cloudflare.ai.ai_search + name: ai_search + title: Ai Search methods: - workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_instruct_awq: + autorag_config_ai_search: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1deepseek-coder-6.7b-instruct-awq/post' + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1ai-search/post' response: mediaType: application/json openAPIDocKey: '200' @@ -27546,59 +5623,116 @@ components: {{- $sep := "" -}} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .filters }}{{ $sep }}"filters": {{ if eq (kindOf .filters) "string" }}{{ .filters }}{{ else }}{{ toJson .filters }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .max_num_results }}{{ $sep }}"max_num_results": {{ toJson .max_num_results }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .model }}{{ $sep }}"model": {{ toJson .model }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .ranking_options }}{{ $sep }}"ranking_options": {{ if eq (kindOf .ranking_options) "string" }}{{ .ranking_options }}{{ else }}{{ toJson .ranking_options }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .reranking }}{{ $sep }}"reranking": {{ if eq (kindOf .reranking) "string" }}{{ .reranking }}{{ else }}{{ toJson .reranking }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .rewrite_query }}{{ $sep }}"rewrite_query": {{ toJson .rewrite_query }}{{- $sep = "," -}}{{ end }} {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} - - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} - - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} - - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .system_prompt }}{{ $sep }}"system_prompt": {{ toJson .system_prompt }}{{- $sep = "," -}}{{ end }} } ' sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/deepseek_coder_6_7b_instruct_awq/methods/workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_instruct_awq' + select: + - $ref: '#/components/x-stackQL-resources/ai_search/methods/autorag_config_ai_search' + insert: [] + update: [] + delete: [] + replace: [] + files: + id: cloudflare.ai.files + name: files + title: Files + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + jobs: + id: cloudflare.ai.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sync: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1sync/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + logs: + id: cloudflare.ai.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs~1{job_id}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] update: [] delete: [] replace: [] - llama_2_13b_chat_awq: - id: cloudflare.ai.llama_2_13b_chat_awq - name: llama_2_13b_chat_awq - title: Llama 2 13b Chat Awq + search: + id: cloudflare.ai.search + name: search + title: Search methods: - workers_ai_post_run_hf_thebloke_llama_2_13b_chat_awq: + autorag_config_search: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1llama-2-13b-chat-awq/post' + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1search/post' response: mediaType: application/json openAPIDocKey: '200' @@ -27610,64 +5744,43 @@ components: {{- $sep := "" -}} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} - - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} - - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .filters }}{{ $sep }}"filters": {{ if eq (kindOf .filters) "string" }}{{ .filters }}{{ else }}{{ toJson .filters }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .max_num_results }}{{ $sep }}"max_num_results": {{ toJson .max_num_results }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .ranking_options }}{{ $sep }}"ranking_options": {{ if eq (kindOf .ranking_options) "string" }}{{ .ranking_options }}{{ else }}{{ toJson .ranking_options }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .reranking }}{{ $sep }}"reranking": {{ if eq (kindOf .reranking) "string" }}{{ .reranking }}{{ else }}{{ toJson .reranking }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .rewrite_query }}{{ $sep }}"rewrite_query": {{ toJson .rewrite_query }}{{- $sep = "," -}}{{ end }} } ' sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/llama_2_13b_chat_awq/methods/workers_ai_post_run_hf_thebloke_llama_2_13b_chat_awq' + select: + - $ref: '#/components/x-stackQL-resources/search/methods/autorag_config_search' + insert: [] update: [] delete: [] replace: [] - mistral_7b_instruct_v0_1_awq: - id: cloudflare.ai.mistral_7b_instruct_v0_1_awq - name: mistral_7b_instruct_v0_1_awq - title: Mistral 7b Instruct V0 1 Awq + text_generation: + id: cloudflare.ai.text_generation + name: text_generation + title: Text Generation methods: - workers_ai_post_run_hf_thebloke_mistral_7b_instruct_v0_1_awq: + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1mistral-7b-instruct-v0.1-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiTextGenerationRunInput' transform: type: golang_template_json_v0.3.0 body: '{ @@ -27706,552 +5819,545 @@ components: {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} - } + {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/mistral_7b_instruct_v0_1_awq/methods/workers_ai_post_run_hf_thebloke_mistral_7b_instruct_v0_1_awq' - update: [] - delete: [] - replace: [] - neural_chat_7b_v3_1_awq: - id: cloudflare.ai.neural_chat_7b_v3_1_awq - name: neural_chat_7b_v3_1_awq - title: Neural Chat 7b V3 1 Awq - methods: - workers_ai_post_run_hf_thebloke_neural_chat_7b_v3_1_awq: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1neural-chat-7b-v3-1-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .guided_json }}{{ $sep }}"guided_json": {{ if eq (kindOf .guided_json) "string" }}{{ .guided_json }}{{ else }}{{ toJson .guided_json }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .chat_template_kwargs }}{{ $sep }}"chat_template_kwargs": {{ if eq (kindOf .chat_template_kwargs) "string" }}{{ .chat_template_kwargs }}{{ else }}{{ toJson .chat_template_kwargs }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .function_call }}{{ $sep }}"function_call": {{ toJson .function_call }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .logit_bias }}{{ $sep }}"logit_bias": {{ if eq (kindOf .logit_bias) "string" }}{{ .logit_bias }}{{ else }}{{ toJson .logit_bias }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .logprobs }}{{ $sep }}"logprobs": {{ toJson .logprobs }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .max_completion_tokens }}{{ $sep }}"max_completion_tokens": {{ toJson .max_completion_tokens }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .metadata }}{{ $sep }}"metadata": {{ if eq (kindOf .metadata) "string" }}{{ .metadata }}{{ else }}{{ toJson .metadata }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .modalities }}{{ $sep }}"modalities": {{ if eq (kindOf .modalities) "string" }}{{ .modalities }}{{ else }}{{ toJson .modalities }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .model }}{{ $sep }}"model": {{ toJson .model }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .n }}{{ $sep }}"n": {{ toJson .n }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .parallel_tool_calls }}{{ $sep }}"parallel_tool_calls": {{ toJson .parallel_tool_calls }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .prediction }}{{ $sep }}"prediction": {{ if eq (kindOf .prediction) "string" }}{{ .prediction }}{{ else }}{{ toJson .prediction }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .reasoning_effort }}{{ $sep }}"reasoning_effort": {{ toJson .reasoning_effort }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .service_tier }}{{ $sep }}"service_tier": {{ toJson .service_tier }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .stop }}{{ $sep }}"stop": {{ toJson .stop }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .store }}{{ $sep }}"store": {{ toJson .store }}{{- $sep = "," -}}{{ end }} + + {{- if .stream_options }}{{ $sep }}"stream_options": {{ if eq (kindOf .stream_options) "string" }}{{ .stream_options }}{{ else }}{{ toJson .stream_options }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .tool_choice }}{{ $sep }}"tool_choice": {{ toJson .tool_choice }}{{- $sep = "," -}}{{ end }} + + {{- if .top_logprobs }}{{ $sep }}"top_logprobs": {{ toJson .top_logprobs }}{{- $sep = "," -}}{{ end }} + + {{- if .user }}{{ $sep }}"user": {{ toJson .user }}{{- $sep = "," -}}{{ end }} + + {{- if .web_search_options }}{{ $sep }}"web_search_options": {{ if eq (kindOf .web_search_options) "string" }}{{ .web_search_options }}{{ else }}{{ toJson .web_search_options }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .input }}{{ $sep }}"input": {{ toJson .input }}{{- $sep = "," -}}{{ end }} + + {{- if .reasoning }}{{ $sep }}"reasoning": {{ if eq (kindOf .reasoning) "string" }}{{ .reasoning }}{{ else }}{{ toJson .reasoning }}{{ end }}{{- $sep = "," -}}{{ end }} } ' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/neural_chat_7b_v3_1_awq/methods/workers_ai_post_run_hf_thebloke_neural_chat_7b_v3_1_awq' + select: + - $ref: '#/components/x-stackQL-resources/text_generation/methods/run' + insert: [] update: [] delete: [] replace: [] - openhermes_2_5_mistral_7b_awq: - id: cloudflare.ai.openhermes_2_5_mistral_7b_awq - name: openhermes_2_5_mistral_7b_awq - title: Openhermes 2 5 Mistral 7b Awq + text_embeddings: + id: cloudflare.ai.text_embeddings + name: text_embeddings + title: Text Embeddings methods: - workers_ai_post_run_hf_thebloke_openhermes_2_5_mistral_7b_awq: + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1openhermes-2.5-mistral-7b-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiTextEmbeddingsRunInput' transform: type: golang_template_json_v0.3.0 body: '{ {{- $sep := "" -}} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} - - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} - - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} - - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .pooling }}{{ $sep }}"pooling": {{ toJson .pooling }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .contexts }}{{ $sep }}"contexts": {{ if eq (kindOf .contexts) "string" }}{{ .contexts }}{{ else }}{{ toJson .contexts }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .truncate_inputs }}{{ $sep }}"truncate_inputs": {{ toJson .truncate_inputs }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .documents }}{{ $sep }}"documents": {{ toJson .documents }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .instruction }}{{ $sep }}"instruction": {{ toJson .instruction }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .queries }}{{ $sep }}"queries": {{ toJson .queries }}{{- $sep = "," -}}{{ end }} } ' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/openhermes_2_5_mistral_7b_awq/methods/workers_ai_post_run_hf_thebloke_openhermes_2_5_mistral_7b_awq' + select: + - $ref: '#/components/x-stackQL-resources/text_embeddings/methods/run' + insert: [] update: [] delete: [] replace: [] - zephyr_7b_beta_awq: - id: cloudflare.ai.zephyr_7b_beta_awq - name: zephyr_7b_beta_awq - title: Zephyr 7b Beta Awq + speech_to_text: + id: cloudflare.ai.speech_to_text + name: speech_to_text + title: Speech to Text methods: - workers_ai_post_run_hf_thebloke_zephyr_7b_beta_awq: + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1zephyr-7b-beta-awq/post' - response: - mediaType: application/json - openAPIDocKey: '200' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiSpeechToTextRunInput' transform: type: golang_template_json_v0.3.0 body: '{ {{- $sep := "" -}} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} - - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .eager_eot_threshold }}{{ $sep }}"eager_eot_threshold": {{ toJson .eager_eot_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .encoding }}{{ $sep }}"encoding": {{ toJson .encoding }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .eot_threshold }}{{ $sep }}"eot_threshold": {{ toJson .eot_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .eot_timeout_ms }}{{ $sep }}"eot_timeout_ms": {{ toJson .eot_timeout_ms }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .keyterm }}{{ $sep }}"keyterm": {{ toJson .keyterm }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .mip_opt_out }}{{ $sep }}"mip_opt_out": {{ toJson .mip_opt_out }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .sample_rate }}{{ $sep }}"sample_rate": {{ toJson .sample_rate }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .tag }}{{ $sep }}"tag": {{ toJson .tag }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .channels }}{{ $sep }}"channels": {{ toJson .channels }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .custom_intent }}{{ $sep }}"custom_intent": {{ toJson .custom_intent }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .custom_intent_mode }}{{ $sep }}"custom_intent_mode": {{ toJson .custom_intent_mode }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .custom_topic }}{{ $sep }}"custom_topic": {{ toJson .custom_topic }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .custom_topic_mode }}{{ $sep }}"custom_topic_mode": {{ toJson .custom_topic_mode }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .detect_entities }}{{ $sep }}"detect_entities": {{ toJson .detect_entities }}{{- $sep = "," -}}{{ end }} - } + {{- if .detect_language }}{{ $sep }}"detect_language": {{ toJson .detect_language }}{{- $sep = "," -}}{{ end }} - ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/zephyr_7b_beta_awq/methods/workers_ai_post_run_hf_thebloke_zephyr_7b_beta_awq' - update: [] - delete: [] - replace: [] - run: - id: cloudflare.ai.run - name: run - title: Run - methods: - run: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ + {{- if .diarize }}{{ $sep }}"diarize": {{ toJson .diarize }}{{- $sep = "," -}}{{ end }} - {{- $sep := "" -}} + {{- if .dictation }}{{ $sep }}"dictation": {{ toJson .dictation }}{{- $sep = "," -}}{{ end }} - {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} + {{- if .endpointing }}{{ $sep }}"endpointing": {{ toJson .endpointing }}{{- $sep = "," -}}{{ end }} - {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} + {{- if .extra }}{{ $sep }}"extra": {{ toJson .extra }}{{- $sep = "," -}}{{ end }} - {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} + {{- if .filler_words }}{{ $sep }}"filler_words": {{ toJson .filler_words }}{{- $sep = "," -}}{{ end }} - {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .interim_results }}{{ $sep }}"interim_results": {{ toJson .interim_results }}{{- $sep = "," -}}{{ end }} - {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} + {{- if .keywords }}{{ $sep }}"keywords": {{ toJson .keywords }}{{- $sep = "," -}}{{ end }} - {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .language }}{{ $sep }}"language": {{ toJson .language }}{{- $sep = "," -}}{{ end }} - {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} + {{- if .measurements }}{{ $sep }}"measurements": {{ toJson .measurements }}{{- $sep = "," -}}{{ end }} - {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} + {{- if .mode }}{{ $sep }}"mode": {{ toJson .mode }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + {{- if .multichannel }}{{ $sep }}"multichannel": {{ toJson .multichannel }}{{- $sep = "," -}}{{ end }} - {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + {{- if .numerals }}{{ $sep }}"numerals": {{ toJson .numerals }}{{- $sep = "," -}}{{ end }} - {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} + {{- if .paragraphs }}{{ $sep }}"paragraphs": {{ toJson .paragraphs }}{{- $sep = "," -}}{{ end }} - {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} + {{- if .profanity_filter }}{{ $sep }}"profanity_filter": {{ toJson .profanity_filter }}{{- $sep = "," -}}{{ end }} - {{- if .lang }}{{ $sep }}"lang": {{ toJson .lang }}{{- $sep = "," -}}{{ end }} + {{- if .punctuate }}{{ $sep }}"punctuate": {{ toJson .punctuate }}{{- $sep = "," -}}{{ end }} - {{- if .audio }}{{ $sep }}"audio": {{ if eq (kindOf .audio) "string" }}{{ .audio }}{{ else }}{{ toJson .audio }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .redact }}{{ $sep }}"redact": {{ toJson .redact }}{{- $sep = "," -}}{{ end }} - {{- if .source_lang }}{{ $sep }}"source_lang": {{ toJson .source_lang }}{{- $sep = "," -}}{{ end }} + {{- if .replace }}{{ $sep }}"replace": {{ toJson .replace }}{{- $sep = "," -}}{{ end }} - {{- if .target_lang }}{{ $sep }}"target_lang": {{ toJson .target_lang }}{{- $sep = "," -}}{{ end }} + {{- if .search }}{{ $sep }}"search": {{ toJson .search }}{{- $sep = "," -}}{{ end }} - {{- if .frequency_penalty }}{{ $sep }}"frequency_penalty": {{ toJson .frequency_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .sentiment }}{{ $sep }}"sentiment": {{ toJson .sentiment }}{{- $sep = "," -}}{{ end }} - {{- if .lora }}{{ $sep }}"lora": {{ toJson .lora }}{{- $sep = "," -}}{{ end }} + {{- if .smart_format }}{{ $sep }}"smart_format": {{ toJson .smart_format }}{{- $sep = "," -}}{{ end }} - {{- if .max_tokens }}{{ $sep }}"max_tokens": {{ toJson .max_tokens }}{{- $sep = "," -}}{{ end }} + {{- if .topics }}{{ $sep }}"topics": {{ toJson .topics }}{{- $sep = "," -}}{{ end }} - {{- if .presence_penalty }}{{ $sep }}"presence_penalty": {{ toJson .presence_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .utt_split }}{{ $sep }}"utt_split": {{ toJson .utt_split }}{{- $sep = "," -}}{{ end }} - {{- if .raw }}{{ $sep }}"raw": {{ toJson .raw }}{{- $sep = "," -}}{{ end }} + {{- if .utterance_end_ms }}{{ $sep }}"utterance_end_ms": {{ toJson .utterance_end_ms }}{{- $sep = "," -}}{{ end }} - {{- if .repetition_penalty }}{{ $sep }}"repetition_penalty": {{ toJson .repetition_penalty }}{{- $sep = "," -}}{{ end }} + {{- if .utterances }}{{ $sep }}"utterances": {{ toJson .utterances }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .vad_events }}{{ $sep }}"vad_events": {{ toJson .vad_events }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .beam_size }}{{ $sep }}"beam_size": {{ toJson .beam_size }}{{- $sep = "," -}}{{ end }} - {{- if .temperature }}{{ $sep }}"temperature": {{ toJson .temperature }}{{- $sep = "," -}}{{ end }} + {{- if .compression_ratio_threshold }}{{ $sep }}"compression_ratio_threshold": {{ toJson .compression_ratio_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} + {{- if .condition_on_previous_text }}{{ $sep }}"condition_on_previous_text": {{ toJson .condition_on_previous_text }}{{- $sep = "," -}}{{ end }} - {{- if .top_p }}{{ $sep }}"top_p": {{ toJson .top_p }}{{- $sep = "," -}}{{ end }} + {{- if .hallucination_silence_threshold }}{{ $sep }}"hallucination_silence_threshold": {{ toJson .hallucination_silence_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .functions }}{{ $sep }}"functions": {{ if eq (kindOf .functions) "string" }}{{ .functions }}{{ else }}{{ toJson .functions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .initial_prompt }}{{ $sep }}"initial_prompt": {{ toJson .initial_prompt }}{{- $sep = "," -}}{{ end }} - {{- if .messages }}{{ $sep }}"messages": {{ if eq (kindOf .messages) "string" }}{{ .messages }}{{ else }}{{ toJson .messages }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .log_prob_threshold }}{{ $sep }}"log_prob_threshold": {{ toJson .log_prob_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .tools }}{{ $sep }}"tools": {{ if eq (kindOf .tools) "string" }}{{ .tools }}{{ else }}{{ toJson .tools }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .no_speech_threshold }}{{ $sep }}"no_speech_threshold": {{ toJson .no_speech_threshold }}{{- $sep = "," -}}{{ end }} - {{- if .input_text }}{{ $sep }}"input_text": {{ toJson .input_text }}{{- $sep = "," -}}{{ end }} + {{- if .prefix }}{{ $sep }}"prefix": {{ toJson .prefix }}{{- $sep = "," -}}{{ end }} - {{- if .max_length }}{{ $sep }}"max_length": {{ toJson .max_length }}{{- $sep = "," -}}{{ end }} + {{- if .task }}{{ $sep }}"task": {{ toJson .task }}{{- $sep = "," -}}{{ end }} - {{- if .ignore_eos }}{{ $sep }}"ignore_eos": {{ toJson .ignore_eos }}{{- $sep = "," -}}{{ end }} + {{- if .vad_filter }}{{ $sep }}"vad_filter": {{ toJson .vad_filter }}{{- $sep = "," -}}{{ end }} } ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/run/methods/run' - update: [] - delete: [] - replace: [] - tasks: - id: cloudflare.ai.tasks - name: tasks - title: Tasks - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1tasks~1search/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tasks/methods/list' + - $ref: '#/components/x-stackQL-resources/speech_to_text/methods/run' insert: [] update: [] delete: [] replace: [] - tomarkdown: - id: cloudflare.ai.tomarkdown - name: tomarkdown - title: Tomarkdown + translation: + id: cloudflare.ai.translation + name: translation + title: Translation methods: - workers_ai_post_to_markdown: + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1tomarkdown/post' - response: - mediaType: application/json - openAPIDocKey: '200' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiTranslationRunInput' transform: type: golang_template_json_v0.3.0 body: '{ {{- $sep := "" -}} - {{- if .files }}{{ $sep }}"files": {{ if eq (kindOf .files) "string" }}{{ .files }}{{ else }}{{ toJson .files }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .target_language }}{{ $sep }}"target_language": {{ toJson .target_language }}{{- $sep = "," -}}{{ end }} + + {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} + + {{- if .source_lang }}{{ $sep }}"source_lang": {{ toJson .source_lang }}{{- $sep = "," -}}{{ end }} + + {{- if .target_lang }}{{ $sep }}"target_lang": {{ toJson .target_lang }}{{- $sep = "," -}}{{ end }} + + {{- if .requests }}{{ $sep }}"requests": {{ if eq (kindOf .requests) "string" }}{{ .requests }}{{ else }}{{ toJson .requests }}{{ end }}{{- $sep = "," -}}{{ end }} } ' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/tomarkdown/methods/workers_ai_post_to_markdown' + select: + - $ref: '#/components/x-stackQL-resources/translation/methods/run' + insert: [] update: [] delete: [] replace: [] - to_markdown: - id: cloudflare.ai.to_markdown - name: to_markdown - title: To Markdown + summarization: + id: cloudflare.ai.summarization + name: summarization + title: Summarization methods: - list: + run: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1ai~1tomarkdown~1supported/get' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' + request: + mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiSummarizationRunInput' + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .input_text }}{{ $sep }}"input_text": {{ toJson .input_text }}{{- $sep = "," -}}{{ end }} + + {{- if .max_length }}{{ $sep }}"max_length": {{ toJson .max_length }}{{- $sep = "," -}}{{ end }} + + } + + ' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/to_markdown/methods/list' + - $ref: '#/components/x-stackQL-resources/summarization/methods/run' insert: [] update: [] delete: [] replace: [] - ai_search: - id: cloudflare.ai.ai_search - name: ai_search - title: Ai Search + text_to_image: + id: cloudflare.ai.text_to_image + name: text_to_image + title: Text to Image methods: - autorag_config_ai_search: + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1ai-search/post' - response: - mediaType: application/json - openAPIDocKey: '200' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiTextToImageRunInput' transform: type: golang_template_json_v0.3.0 body: '{ {{- $sep := "" -}} - {{- if .filters }}{{ $sep }}"filters": {{ if eq (kindOf .filters) "string" }}{{ .filters }}{{ else }}{{ toJson .filters }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - {{- if .max_num_results }}{{ $sep }}"max_num_results": {{ toJson .max_num_results }}{{- $sep = "," -}}{{ end }} + {{- if .steps }}{{ $sep }}"steps": {{ toJson .steps }}{{- $sep = "," -}}{{ end }} - {{- if .model }}{{ $sep }}"model": {{ toJson .model }}{{- $sep = "," -}}{{ end }} + {{- if .multipart }}{{ $sep }}"multipart": {{ if eq (kindOf .multipart) "string" }}{{ .multipart }}{{ else }}{{ toJson .multipart }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} + {{- if .guidance }}{{ $sep }}"guidance": {{ toJson .guidance }}{{- $sep = "," -}}{{ end }} - {{- if .ranking_options }}{{ $sep }}"ranking_options": {{ if eq (kindOf .ranking_options) "string" }}{{ .ranking_options }}{{ else }}{{ toJson .ranking_options }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .height }}{{ $sep }}"height": {{ toJson .height }}{{- $sep = "," -}}{{ end }} - {{- if .reranking }}{{ $sep }}"reranking": {{ if eq (kindOf .reranking) "string" }}{{ .reranking }}{{ else }}{{ toJson .reranking }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .image }}{{ $sep }}"image": {{ if eq (kindOf .image) "string" }}{{ .image }}{{ else }}{{ toJson .image }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .rewrite_query }}{{ $sep }}"rewrite_query": {{ toJson .rewrite_query }}{{- $sep = "," -}}{{ end }} + {{- if .image_b64 }}{{ $sep }}"image_b64": {{ toJson .image_b64 }}{{- $sep = "," -}}{{ end }} - {{- if .stream }}{{ $sep }}"stream": {{ toJson .stream }}{{- $sep = "," -}}{{ end }} + {{- if .mask }}{{ $sep }}"mask": {{ if eq (kindOf .mask) "string" }}{{ .mask }}{{ else }}{{ toJson .mask }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .system_prompt }}{{ $sep }}"system_prompt": {{ toJson .system_prompt }}{{- $sep = "," -}}{{ end }} + {{- if .negative_prompt }}{{ $sep }}"negative_prompt": {{ toJson .negative_prompt }}{{- $sep = "," -}}{{ end }} + + {{- if .num_steps }}{{ $sep }}"num_steps": {{ toJson .num_steps }}{{- $sep = "," -}}{{ end }} + + {{- if .seed }}{{ $sep }}"seed": {{ toJson .seed }}{{- $sep = "," -}}{{ end }} + + {{- if .strength }}{{ $sep }}"strength": {{ toJson .strength }}{{- $sep = "," -}}{{ end }} + + {{- if .width }}{{ $sep }}"width": {{ toJson .width }}{{- $sep = "," -}}{{ end }} } ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/ai_search/methods/autorag_config_ai_search' - update: [] - delete: [] - replace: [] - files: - id: cloudflare.ai.files - name: files - title: Files - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1files/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/files/methods/list' + - $ref: '#/components/x-stackQL-resources/text_to_image/methods/run' insert: [] update: [] delete: [] replace: [] - jobs: - id: cloudflare.ai.jobs - name: jobs - title: Jobs + text_to_speech: + id: cloudflare.ai.text_to_speech + name: text_to_speech + title: Text to Speech methods: - list: + run: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs/get' - response: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' + request: mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs~1{job_id}/get' + schema_override: + $ref: '#/components/schemas/stackqlAiTextToSpeechRunInput' + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .bit_rate }}{{ $sep }}"bit_rate": {{ toJson .bit_rate }}{{- $sep = "," -}}{{ end }} + + {{- if .container }}{{ $sep }}"container": {{ toJson .container }}{{- $sep = "," -}}{{ end }} + + {{- if .encoding }}{{ $sep }}"encoding": {{ toJson .encoding }}{{- $sep = "," -}}{{ end }} + + {{- if .sample_rate }}{{ $sep }}"sample_rate": {{ toJson .sample_rate }}{{- $sep = "," -}}{{ end }} + + {{- if .speaker }}{{ $sep }}"speaker": {{ toJson .speaker }}{{- $sep = "," -}}{{ end }} + + {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} + + {{- if .lang }}{{ $sep }}"lang": {{ toJson .lang }}{{- $sep = "," -}}{{ end }} + + {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} + + } + + ' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/text_to_speech/methods/run' insert: [] update: [] delete: [] replace: [] - logs: - id: cloudflare.ai.logs - name: logs - title: Logs + text_classification: + id: cloudflare.ai.text_classification + name: text_classification + title: Text Classification methods: - list: + run: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs~1{job_id}~1logs/get' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' + request: + mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiTextClassificationRunInput' + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .text }}{{ $sep }}"text": {{ toJson .text }}{{- $sep = "," -}}{{ end }} + + } + + ' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/logs/methods/list' + - $ref: '#/components/x-stackQL-resources/text_classification/methods/run' insert: [] update: [] delete: [] replace: [] - search: - id: cloudflare.ai.search - name: search - title: Search + reranking: + id: cloudflare.ai.reranking + name: reranking + title: Reranking methods: - autorag_config_search: + run: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1search/post' - response: - mediaType: application/json - openAPIDocKey: '200' + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' request: mediaType: application/json + schema_override: + $ref: '#/components/schemas/stackqlAiRerankingRunInput' transform: type: golang_template_json_v0.3.0 body: '{ {{- $sep := "" -}} - {{- if .filters }}{{ $sep }}"filters": {{ if eq (kindOf .filters) "string" }}{{ .filters }}{{ else }}{{ toJson .filters }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .max_num_results }}{{ $sep }}"max_num_results": {{ toJson .max_num_results }}{{- $sep = "," -}}{{ end }} + {{- if .contexts }}{{ $sep }}"contexts": {{ if eq (kindOf .contexts) "string" }}{{ .contexts }}{{ else }}{{ toJson .contexts }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .query }}{{ $sep }}"query": {{ toJson .query }}{{- $sep = "," -}}{{ end }} - {{- if .ranking_options }}{{ $sep }}"ranking_options": {{ if eq (kindOf .ranking_options) "string" }}{{ .ranking_options }}{{ else }}{{ toJson .ranking_options }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .reranking }}{{ $sep }}"reranking": {{ if eq (kindOf .reranking) "string" }}{{ .reranking }}{{ else }}{{ toJson .reranking }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .rewrite_query }}{{ $sep }}"rewrite_query": {{ toJson .rewrite_query }}{{- $sep = "," -}}{{ end }} + {{- if .top_k }}{{ $sep }}"top_k": {{ toJson .top_k }}{{- $sep = "," -}}{{ end }} } ' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/search/methods/autorag_config_search' - update: [] - delete: [] - replace: [] - sync: - id: cloudflare.ai.sync - name: sync - title: Sync - methods: - autorag_config_sync: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1sync/patch' response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/reranking/methods/run' insert: [] - update: - - $ref: '#/components/x-stackQL-resources/sync/methods/autorag_config_sync' + update: [] delete: [] replace: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_gateway.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_gateway.yaml index aac29090772..afacb060853 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_gateway.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_gateway.yaml @@ -7508,7 +7508,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + objectKey: $.data.routes create: config: requestBodyTranslate: diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/aisearch.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_search.yaml similarity index 97% rename from stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/aisearch.yaml rename to stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_search.yaml index 6c50e27038d..c89ce04dec0 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/aisearch.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ai_search.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - title: aisearch API + title: ai_search API description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 @@ -649,7 +649,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: list @@ -1698,7 +1698,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: create @@ -2271,7 +2271,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: delete @@ -2843,7 +2843,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: read @@ -3928,7 +3928,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: update @@ -4312,7 +4312,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: chat_completions @@ -4502,7 +4502,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances - jobs @@ -4695,7 +4695,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances - jobs @@ -4829,7 +4829,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances - jobs @@ -5183,7 +5183,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances - jobs @@ -5514,7 +5514,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: search @@ -5641,7 +5641,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - instances method: stats @@ -5778,7 +5778,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: list @@ -5938,7 +5938,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: create @@ -6044,7 +6044,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: delete @@ -6138,7 +6138,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: read @@ -6269,7 +6269,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: update @@ -6680,7 +6680,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: chat_completions @@ -7327,7 +7327,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -8383,7 +8383,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -8963,7 +8963,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -9542,7 +9542,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -10751,7 +10751,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -11142,7 +11142,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -11434,7 +11434,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -11633,7 +11633,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -11859,7 +11859,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -11981,7 +11981,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -12166,7 +12166,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -12398,7 +12398,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -12602,7 +12602,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -12740,7 +12740,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -12948,7 +12948,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -13146,7 +13146,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -13346,7 +13346,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -13487,7 +13487,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -13665,7 +13665,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -13861,7 +13861,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -14199,7 +14199,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -14333,7 +14333,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces - instances @@ -14691,7 +14691,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - namespaces method: search @@ -14855,7 +14855,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - tokens method: list @@ -14990,7 +14990,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - tokens method: create @@ -15127,7 +15127,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - tokens method: delete @@ -15278,7 +15278,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - tokens method: read @@ -15445,7 +15445,7 @@ paths: free: true pro: true x-stackql-sdk: - service: aisearch + service: ai_search resource_chain: - tokens method: update @@ -15478,7 +15478,7 @@ components: description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: instances: - id: cloudflare.aisearch.instances + id: cloudflare.ai_search.instances name: instances title: Instances methods: @@ -15679,7 +15679,7 @@ components: replace: - $ref: '#/components/x-stackQL-resources/instances/methods/update_by_account' chat_completions: - id: cloudflare.aisearch.chat_completions + id: cloudflare.ai_search.chat_completions name: chat_completions title: Chat Completions methods: @@ -15740,15 +15740,15 @@ components: ' sqlVerbs: - select: [] - insert: + select: - $ref: '#/components/x-stackQL-resources/chat_completions/methods/chat_completions_by_account' - $ref: '#/components/x-stackQL-resources/chat_completions/methods/chat_completions' + insert: [] update: [] delete: [] replace: [] jobs: - id: cloudflare.aisearch.jobs + id: cloudflare.ai_search.jobs name: jobs title: Jobs methods: @@ -15805,7 +15805,7 @@ components: delete: [] replace: [] jobs_logs: - id: cloudflare.aisearch.jobs_logs + id: cloudflare.ai_search.jobs_logs name: jobs_logs title: Jobs Logs methods: @@ -15824,7 +15824,7 @@ components: delete: [] replace: [] instances_search: - id: cloudflare.aisearch.instances_search + id: cloudflare.ai_search.instances_search name: instances_search title: Instances Search methods: @@ -15855,14 +15855,14 @@ components: ' sqlVerbs: - select: [] - insert: + select: - $ref: '#/components/x-stackQL-resources/instances_search/methods/search_by_account' + insert: [] update: [] delete: [] replace: [] instances_stats: - id: cloudflare.aisearch.instances_stats + id: cloudflare.ai_search.instances_stats name: instances_stats title: Instances Stats methods: @@ -15881,7 +15881,7 @@ components: delete: [] replace: [] namespaces: - id: cloudflare.aisearch.namespaces + id: cloudflare.ai_search.namespaces name: namespaces title: Namespaces methods: @@ -15935,7 +15935,7 @@ components: replace: - $ref: '#/components/x-stackQL-resources/namespaces/methods/update' namespace_instances: - id: cloudflare.aisearch.namespace_instances + id: cloudflare.ai_search.namespace_instances name: namespace_instances title: Namespace Instances methods: @@ -16127,7 +16127,7 @@ components: replace: - $ref: '#/components/x-stackQL-resources/namespace_instances/methods/update_by_account' namespace_instance_chat_completions: - id: cloudflare.aisearch.namespace_instance_chat_completions + id: cloudflare.ai_search.namespace_instance_chat_completions name: namespace_instance_chat_completions title: Namespace Instance Chat Completions methods: @@ -16160,14 +16160,14 @@ components: ' sqlVerbs: - select: [] - insert: + select: - $ref: '#/components/x-stackQL-resources/namespace_instance_chat_completions/methods/chat_completions_by_account' + insert: [] update: [] delete: [] replace: [] instances_items: - id: cloudflare.aisearch.instances_items + id: cloudflare.ai_search.instances_items name: instances_items title: Instances Items methods: @@ -16186,7 +16186,7 @@ components: delete: [] replace: [] items: - id: cloudflare.aisearch.items + id: cloudflare.ai_search.items name: items title: Items methods: @@ -16242,7 +16242,7 @@ components: replace: - $ref: '#/components/x-stackQL-resources/items/methods/create_or_update' item_chunks: - id: cloudflare.aisearch.item_chunks + id: cloudflare.ai_search.item_chunks name: item_chunks title: Item Chunks methods: @@ -16261,7 +16261,7 @@ components: delete: [] replace: [] items_download: - id: cloudflare.aisearch.items_download + id: cloudflare.ai_search.items_download name: items_download title: Items Download methods: @@ -16283,7 +16283,7 @@ components: delete: [] replace: [] item_logs: - id: cloudflare.aisearch.item_logs + id: cloudflare.ai_search.item_logs name: item_logs title: Item Logs methods: @@ -16302,7 +16302,7 @@ components: delete: [] replace: [] namespaces_instance_jobs: - id: cloudflare.aisearch.namespaces_instance_jobs + id: cloudflare.ai_search.namespaces_instance_jobs name: namespaces_instance_jobs title: Namespaces Instance Jobs methods: @@ -16339,7 +16339,7 @@ components: delete: [] replace: [] namespaces_instance_job_logs: - id: cloudflare.aisearch.namespaces_instance_job_logs + id: cloudflare.ai_search.namespaces_instance_job_logs name: namespaces_instance_job_logs title: Namespaces Instance Job Logs methods: @@ -16358,7 +16358,7 @@ components: delete: [] replace: [] namespaces_instance_search: - id: cloudflare.aisearch.namespaces_instance_search + id: cloudflare.ai_search.namespaces_instance_search name: namespaces_instance_search title: Namespaces Instance Search methods: @@ -16389,14 +16389,14 @@ components: ' sqlVerbs: - select: [] - insert: + select: - $ref: '#/components/x-stackQL-resources/namespaces_instance_search/methods/search_by_account' + insert: [] update: [] delete: [] replace: [] namespaces_instance_stats: - id: cloudflare.aisearch.namespaces_instance_stats + id: cloudflare.ai_search.namespaces_instance_stats name: namespaces_instance_stats title: Namespaces Instance Stats methods: @@ -16415,7 +16415,7 @@ components: delete: [] replace: [] namespaces_search: - id: cloudflare.aisearch.namespaces_search + id: cloudflare.ai_search.namespaces_search name: namespaces_search title: Namespaces Search methods: @@ -16446,14 +16446,14 @@ components: ' sqlVerbs: - select: [] - insert: + select: - $ref: '#/components/x-stackQL-resources/namespaces_search/methods/search' + insert: [] update: [] delete: [] replace: [] tokens: - id: cloudflare.aisearch.tokens + id: cloudflare.ai_search.tokens name: tokens title: Tokens methods: diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/alerting.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/alerting.yaml index 21bacf73566..9a5058f68a7 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/alerting.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/alerting.yaml @@ -28,7 +28,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/aaaAlertsResponseCollection' + type: object + properties: + contents: + type: string description: Get Alert Types response 4XX: content: @@ -2657,7 +2660,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/available_alerts/methods/list' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/billing.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/billing.yaml index 75375319f83..ea3a8612d31 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/billing.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/billing.yaml @@ -1367,7 +1367,8 @@ components: ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/accounts/methods/query_pay_per_crawl_zones' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/browser_rendering.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/browser_rendering.yaml index 25f37c50a92..0e222bdfeef 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/browser_rendering.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/browser_rendering.yaml @@ -240,38 +240,10 @@ paths: content: application/json: schema: + type: object properties: - errors: - items: - properties: - code: - description: Error code. - type: number - message: - description: Error message. - type: string - required: - - message - - code - type: object - type: array - meta: - properties: - status: - type: number - title: - type: string - type: object - result: - description: HTML content. + contents: type: string - success: - description: Response status. - type: boolean - required: - - success - - meta - type: object description: Returns the page's content. '400': content: @@ -1865,35 +1837,10 @@ paths: content: application/json: schema: - items: - properties: - description: - description: Target description. - type: string - devtoolsFrontendUrl: - description: DevTools frontend URL. - type: string - id: - description: Target ID. - type: string - title: - description: Title of the target. - type: string - type: - description: Target type (page, background_page, worker, etc.). - type: string - url: - description: URL of the target. - type: string - webSocketDebuggerUrl: - description: WebSocket URL for debugging this target. - type: string - required: - - id - - type - - url - type: object - type: array + type: object + properties: + contents: + type: string description: List of targets. '400': content: @@ -2983,30 +2930,10 @@ paths: content: application/json: schema: - properties: - errors: - items: - properties: - code: - description: Error code. - type: number - message: - description: Error message. - type: string - required: - - message - - code - type: object - type: array - result: - type: object - success: - description: Response status. - type: boolean - required: - - success - - result type: object + properties: + contents: + type: string description: Returns the JSON based on a user prompt or JSON schema. '400': content: @@ -3378,32 +3305,10 @@ paths: content: application/json: schema: - properties: - errors: - items: - properties: - code: - description: Error code. - type: number - message: - description: Error message. - type: string - required: - - message - - code - type: object - type: array - result: - items: - type: string - type: array - success: - description: Response status. - type: boolean - required: - - success - - result type: object + properties: + link: + type: string description: Returns the links. '400': content: @@ -3766,30 +3671,10 @@ paths: content: application/json: schema: + type: object properties: - errors: - items: - properties: - code: - description: Error code. - type: number - message: - description: Error message. - type: string - required: - - message - - code - type: object - type: array - result: - description: Markdown content. + contents: type: string - success: - description: Response status. - type: boolean - required: - - success - type: object description: Returns the page markdown. '400': content: @@ -5739,12 +5624,12 @@ components: type: apiKey description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - browser_rendering: - id: cloudflare.browser_rendering.browser_rendering - name: browser_rendering - title: Browser Rendering + content: + id: cloudflare.browser_rendering.content + name: content + title: Content methods: - create_content: + get: config: requestBodyTranslate: algorithm: naive @@ -5753,6 +5638,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 request: mediaType: application/json transform: @@ -5804,12 +5693,24 @@ components: } ' - create_links: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/content/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + crawl: + id: cloudflare.browser_rendering.crawl + name: crawl + title: Crawl + methods: + create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1links/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1crawl/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5837,85 +5738,39 @@ components: {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} - - {{- if .excludeExternalLinks }}{{ $sep }}"excludeExternalLinks": {{ toJson .excludeExternalLinks }}{{- $sep = "," -}}{{ end }} - - {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} - - {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .setJavaScriptEnabled }}{{ $sep }}"setJavaScriptEnabled": {{ toJson .setJavaScriptEnabled }}{{- $sep = "," -}}{{ end }} - - {{- if .userAgent }}{{ $sep }}"userAgent": {{ toJson .userAgent }}{{- $sep = "," -}}{{ end }} - - {{- if .viewport }}{{ $sep }}"viewport": {{ if eq (kindOf .viewport) "string" }}{{ .viewport }}{{ else }}{{ toJson .viewport }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .visibleLinksOnly }}{{ $sep }}"visibleLinksOnly": {{ toJson .visibleLinksOnly }}{{- $sep = "," -}}{{ end }} - - {{- if .waitForSelector }}{{ $sep }}"waitForSelector": {{ if eq (kindOf .waitForSelector) "string" }}{{ .waitForSelector }}{{ else }}{{ toJson .waitForSelector }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .waitForTimeout }}{{ $sep }}"waitForTimeout": {{ toJson .waitForTimeout }}{{- $sep = "," -}}{{ end }} - - {{- if .url }}{{ $sep }}"url": {{ toJson .url }}{{- $sep = "," -}}{{ end }} - - } - - ' - create_markdown: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1markdown/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .actionTimeout }}{{ $sep }}"actionTimeout": {{ toJson .actionTimeout }}{{- $sep = "," -}}{{ end }} + {{- if .crawlPurposes }}{{ $sep }}"crawlPurposes": {{ if eq (kindOf .crawlPurposes) "string" }}{{ .crawlPurposes }}{{ else }}{{ toJson .crawlPurposes }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .addScriptTag }}{{ $sep }}"addScriptTag": {{ if eq (kindOf .addScriptTag) "string" }}{{ .addScriptTag }}{{ else }}{{ toJson .addScriptTag }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .depth }}{{ $sep }}"depth": {{ toJson .depth }}{{- $sep = "," -}}{{ end }} - {{- if .addStyleTag }}{{ $sep }}"addStyleTag": {{ if eq (kindOf .addStyleTag) "string" }}{{ .addStyleTag }}{{ else }}{{ toJson .addStyleTag }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} - {{- if .allowRequestPattern }}{{ $sep }}"allowRequestPattern": {{ if eq (kindOf .allowRequestPattern) "string" }}{{ .allowRequestPattern }}{{ else }}{{ toJson .allowRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .formats }}{{ $sep }}"formats": {{ if eq (kindOf .formats) "string" }}{{ .formats }}{{ else }}{{ toJson .formats }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .allowResourceTypes }}{{ $sep }}"allowResourceTypes": {{ if eq (kindOf .allowResourceTypes) "string" }}{{ .allowResourceTypes }}{{ else }}{{ toJson .allowResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .authenticate }}{{ $sep }}"authenticate": {{ if eq (kindOf .authenticate) "string" }}{{ .authenticate }}{{ else }}{{ toJson .authenticate }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .jsonOptions }}{{ $sep }}"jsonOptions": {{ if eq (kindOf .jsonOptions) "string" }}{{ .jsonOptions }}{{ else }}{{ toJson .jsonOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .bestAttempt }}{{ $sep }}"bestAttempt": {{ toJson .bestAttempt }}{{- $sep = "," -}}{{ end }} + {{- if .limit }}{{ $sep }}"limit": {{ toJson .limit }}{{- $sep = "," -}}{{ end }} - {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .maxAge }}{{ $sep }}"maxAge": {{ toJson .maxAge }}{{- $sep = "," -}}{{ end }} - {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} + {{- if .modifiedSince }}{{ $sep }}"modifiedSince": {{ toJson .modifiedSince }}{{- $sep = "," -}}{{ end }} - {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .options }}{{ $sep }}"options": {{ if eq (kindOf .options) "string" }}{{ .options }}{{ else }}{{ toJson .options }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .render }}{{ $sep }}"render": {{ toJson .render }}{{- $sep = "," -}}{{ end }} + {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .setJavaScriptEnabled }}{{ $sep }}"setJavaScriptEnabled": {{ toJson .setJavaScriptEnabled }}{{- $sep = "," -}}{{ end }} - {{- if .url }}{{ $sep }}"url": {{ toJson .url }}{{- $sep = "," -}}{{ end }} + {{- if .source }}{{ $sep }}"source": {{ toJson .source }}{{- $sep = "," -}}{{ end }} - {{- if .userAgent }}{{ $sep }}"userAgent": {{ toJson .userAgent }}{{- $sep = "," -}}{{ end }} + {{- if .url }}{{ $sep }}"url": {{ toJson .url }}{{- $sep = "," -}}{{ end }} {{- if .viewport }}{{ $sep }}"viewport": {{ if eq (kindOf .viewport) "string" }}{{ .viewport }}{{ else }}{{ toJson .viewport }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -5923,32 +5778,246 @@ components: {{- if .waitForTimeout }}{{ $sep }}"waitForTimeout": {{ toJson .waitForTimeout }}{{- $sep = "," -}}{{ end }} - {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} - } ' - create_pdf: - config: - requestBodyTranslate: - algorithm: naive + delete: operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1pdf/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1crawl~1{job_id}/delete' response: - mediaType: application/pdf + mediaType: application/json openAPIDocKey: '200' - overrideMediaType: application/json - transform: - body: '[{"contents": {{ toJson . }}}]' - type: golang_template_text_v0.3.0 - request: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1crawl~1{job_id}/get' + response: mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/crawl/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/crawl/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/crawl/methods/delete' + replace: [] + browser: + id: cloudflare.browser_rendering.browser + name: browser + title: Browser + methods: + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/browser/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/browser/methods/delete' + replace: [] + json: + id: cloudflare.browser_rendering.json + name: json + title: Json + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + json_activate: + id: cloudflare.browser_rendering.json_activate + name: json_activate + title: Json Activate + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1activate~1{target_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json_activate/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + json_close: + id: cloudflare.browser_rendering.json_close + name: json_close + title: Json Close + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1close~1{target_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json_close/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + targets: + id: cloudflare.browser_rendering.targets + name: targets + title: Targets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1list/get' + response: + mediaType: application/json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1new/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/targets/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/targets/methods/create' + json_list: + id: cloudflare.browser_rendering.json_list + name: json_list + title: Json List + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1list~1{target_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json_list/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + json_protocol: + id: cloudflare.browser_rendering.json_protocol + name: json_protocol + title: Json Protocol + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.domains + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + json_version: + id: cloudflare.browser_rendering.json_version + name: json_version + title: Json Version + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + session: + id: cloudflare.browser_rendering.session + name: session + title: Session + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1session/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1session~1{session_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/session/methods/get' + - $ref: '#/components/x-stackQL-resources/session/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + json_extract: + id: cloudflare.browser_rendering.json_extract + name: json_extract + title: Json Extract + methods: + get: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1json/post' + response: + mediaType: application/json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + {{- if .actionTimeout }}{{ $sep }}"actionTimeout": {{ toJson .actionTimeout }}{{- $sep = "," -}}{{ end }} {{- if .addScriptTag }}{{ $sep }}"addScriptTag": {{ if eq (kindOf .addScriptTag) "string" }}{{ .addScriptTag }}{{ else }}{{ toJson .addScriptTag }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -5965,18 +6034,22 @@ components: {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .custom_ai }}{{ $sep }}"custom_ai": {{ if eq (kindOf .custom_ai) "string" }}{{ .custom_ai }}{{ else }}{{ toJson .custom_ai }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} - {{- if .pdfOptions }}{{ $sep }}"pdfOptions": {{ if eq (kindOf .pdfOptions) "string" }}{{ .pdfOptions }}{{ else }}{{ toJson .pdfOptions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .setJavaScriptEnabled }}{{ $sep }}"setJavaScriptEnabled": {{ toJson .setJavaScriptEnabled }}{{- $sep = "," -}}{{ end }} @@ -5994,15 +6067,31 @@ components: } ' - create_scrape: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/json_extract/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + links: + id: cloudflare.browser_rendering.links + name: links + title: Links + methods: + get: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1scrape/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1links/post' response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{{ range $i, $v := .result }}{{ if $i }},{{ end }}{"link": {{ toJson $v }}}{{ end }}]' + type: golang_template_json_v0.3.0 request: mediaType: application/json transform: @@ -6027,10 +6116,10 @@ components: {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .elements }}{{ $sep }}"elements": {{ if eq (kindOf .elements) "string" }}{{ .elements }}{{ else }}{{ toJson .elements }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} + {{- if .excludeExternalLinks }}{{ $sep }}"excludeExternalLinks": {{ toJson .excludeExternalLinks }}{{- $sep = "," -}}{{ end }} + {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} @@ -6047,6 +6136,8 @@ components: {{- if .viewport }}{{ $sep }}"viewport": {{ if eq (kindOf .viewport) "string" }}{{ .viewport }}{{ else }}{{ toJson .viewport }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .visibleLinksOnly }}{{ $sep }}"visibleLinksOnly": {{ toJson .visibleLinksOnly }}{{- $sep = "," -}}{{ end }} + {{- if .waitForSelector }}{{ $sep }}"waitForSelector": {{ if eq (kindOf .waitForSelector) "string" }}{{ .waitForSelector }}{{ else }}{{ toJson .waitForSelector }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .waitForTimeout }}{{ $sep }}"waitForTimeout": {{ toJson .waitForTimeout }}{{- $sep = "," -}}{{ end }} @@ -6056,15 +6147,31 @@ components: } ' - create_screenshot: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/links/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + markdown: + id: cloudflare.browser_rendering.markdown + name: markdown + title: Markdown + methods: + get: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1screenshot/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1markdown/post' response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 request: mediaType: application/json transform: @@ -6093,17 +6200,89 @@ components: {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} - {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .screenshotOptions }}{{ $sep }}"screenshotOptions": {{ if eq (kindOf .screenshotOptions) "string" }}{{ .screenshotOptions }}{{ else }}{{ toJson .screenshotOptions }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .scrollPage }}{{ $sep }}"scrollPage": {{ toJson .scrollPage }}{{- $sep = "," -}}{{ end }} + {{- if .setJavaScriptEnabled }}{{ $sep }}"setJavaScriptEnabled": {{ toJson .setJavaScriptEnabled }}{{- $sep = "," -}}{{ end }} - {{- if .selector }}{{ $sep }}"selector": {{ toJson .selector }}{{- $sep = "," -}}{{ end }} + {{- if .url }}{{ $sep }}"url": {{ toJson .url }}{{- $sep = "," -}}{{ end }} + + {{- if .userAgent }}{{ $sep }}"userAgent": {{ toJson .userAgent }}{{- $sep = "," -}}{{ end }} + + {{- if .viewport }}{{ $sep }}"viewport": {{ if eq (kindOf .viewport) "string" }}{{ .viewport }}{{ else }}{{ toJson .viewport }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .waitForSelector }}{{ $sep }}"waitForSelector": {{ if eq (kindOf .waitForSelector) "string" }}{{ .waitForSelector }}{{ else }}{{ toJson .waitForSelector }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .waitForTimeout }}{{ $sep }}"waitForTimeout": {{ toJson .waitForTimeout }}{{- $sep = "," -}}{{ end }} + + {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} + + } + + ' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/markdown/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + pdf: + id: cloudflare.browser_rendering.pdf + name: pdf + title: Pdf + methods: + get: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1pdf/post' + response: + mediaType: application/pdf + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .actionTimeout }}{{ $sep }}"actionTimeout": {{ toJson .actionTimeout }}{{- $sep = "," -}}{{ end }} + + {{- if .addScriptTag }}{{ $sep }}"addScriptTag": {{ if eq (kindOf .addScriptTag) "string" }}{{ .addScriptTag }}{{ else }}{{ toJson .addScriptTag }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .addStyleTag }}{{ $sep }}"addStyleTag": {{ if eq (kindOf .addStyleTag) "string" }}{{ .addStyleTag }}{{ else }}{{ toJson .addStyleTag }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .allowRequestPattern }}{{ $sep }}"allowRequestPattern": {{ if eq (kindOf .allowRequestPattern) "string" }}{{ .allowRequestPattern }}{{ else }}{{ toJson .allowRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .allowResourceTypes }}{{ $sep }}"allowResourceTypes": {{ if eq (kindOf .allowResourceTypes) "string" }}{{ .allowResourceTypes }}{{ else }}{{ toJson .allowResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .authenticate }}{{ $sep }}"authenticate": {{ if eq (kindOf .authenticate) "string" }}{{ .authenticate }}{{ else }}{{ toJson .authenticate }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .bestAttempt }}{{ $sep }}"bestAttempt": {{ toJson .bestAttempt }}{{- $sep = "," -}}{{ end }} + + {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} + + {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} + + {{- if .pdfOptions }}{{ $sep }}"pdfOptions": {{ if eq (kindOf .pdfOptions) "string" }}{{ .pdfOptions }}{{ else }}{{ toJson .pdfOptions }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -6122,12 +6301,24 @@ components: } ' - snapshot: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pdf/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + scrape: + id: cloudflare.browser_rendering.scrape + name: scrape + title: Scrape + methods: + get: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1snapshot/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1scrape/post' response: mediaType: application/json openAPIDocKey: '200' @@ -6155,6 +6346,8 @@ components: {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .elements }}{{ $sep }}"elements": {{ if eq (kindOf .elements) "string" }}{{ .elements }}{{ else }}{{ toJson .elements }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -6165,8 +6358,6 @@ components: {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .screenshotOptions }}{{ $sep }}"screenshotOptions": {{ if eq (kindOf .screenshotOptions) "string" }}{{ .screenshotOptions }}{{ else }}{{ toJson .screenshotOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .setJavaScriptEnabled }}{{ $sep }}"setJavaScriptEnabled": {{ toJson .setJavaScriptEnabled }}{{- $sep = "," -}}{{ end }} @@ -6185,22 +6376,23 @@ components: ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/scrape/methods/get' insert: [] update: [] delete: [] replace: [] - crawl: - id: cloudflare.browser_rendering.crawl - name: crawl - title: Crawl + screenshot: + id: cloudflare.browser_rendering.screenshot + name: screenshot + title: Screenshot methods: - create: + get: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1crawl/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1screenshot/post' response: mediaType: application/json openAPIDocKey: '200' @@ -6228,39 +6420,27 @@ components: {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .crawlPurposes }}{{ $sep }}"crawlPurposes": {{ if eq (kindOf .crawlPurposes) "string" }}{{ .crawlPurposes }}{{ else }}{{ toJson .crawlPurposes }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .depth }}{{ $sep }}"depth": {{ toJson .depth }}{{- $sep = "," -}}{{ end }} - {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} - {{- if .formats }}{{ $sep }}"formats": {{ if eq (kindOf .formats) "string" }}{{ .formats }}{{ else }}{{ toJson .formats }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .jsonOptions }}{{ $sep }}"jsonOptions": {{ if eq (kindOf .jsonOptions) "string" }}{{ .jsonOptions }}{{ else }}{{ toJson .jsonOptions }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .limit }}{{ $sep }}"limit": {{ toJson .limit }}{{- $sep = "," -}}{{ end }} - - {{- if .maxAge }}{{ $sep }}"maxAge": {{ toJson .maxAge }}{{- $sep = "," -}}{{ end }} - - {{- if .modifiedSince }}{{ $sep }}"modifiedSince": {{ toJson .modifiedSince }}{{- $sep = "," -}}{{ end }} - - {{- if .options }}{{ $sep }}"options": {{ if eq (kindOf .options) "string" }}{{ .options }}{{ else }}{{ toJson .options }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .render }}{{ $sep }}"render": {{ toJson .render }}{{- $sep = "," -}}{{ end }} + {{- if .screenshotOptions }}{{ $sep }}"screenshotOptions": {{ if eq (kindOf .screenshotOptions) "string" }}{{ .screenshotOptions }}{{ else }}{{ toJson .screenshotOptions }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .scrollPage }}{{ $sep }}"scrollPage": {{ toJson .scrollPage }}{{- $sep = "," -}}{{ end }} + + {{- if .selector }}{{ $sep }}"selector": {{ toJson .selector }}{{- $sep = "," -}}{{ end }} {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .setJavaScriptEnabled }}{{ $sep }}"setJavaScriptEnabled": {{ toJson .setJavaScriptEnabled }}{{- $sep = "," -}}{{ end }} - {{- if .source }}{{ $sep }}"source": {{ toJson .source }}{{- $sep = "," -}}{{ end }} - - {{- if .url }}{{ $sep }}"url": {{ toJson .url }}{{- $sep = "," -}}{{ end }} + {{- if .userAgent }}{{ $sep }}"userAgent": {{ toJson .userAgent }}{{- $sep = "," -}}{{ end }} {{- if .viewport }}{{ $sep }}"viewport": {{ if eq (kindOf .viewport) "string" }}{{ .viewport }}{{ else }}{{ toJson .viewport }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -6268,73 +6448,29 @@ components: {{- if .waitForTimeout }}{{ $sep }}"waitForTimeout": {{ toJson .waitForTimeout }}{{- $sep = "," -}}{{ end }} + {{- if .url }}{{ $sep }}"url": {{ toJson .url }}{{- $sep = "," -}}{{ end }} + } ' - delete: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1crawl~1{job_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1crawl~1{job_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/crawl/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/crawl/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/crawl/methods/delete' - replace: [] - browser: - id: cloudflare.browser_rendering.browser - name: browser - title: Browser - methods: - create: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/browser/methods/create' + - $ref: '#/components/x-stackQL-resources/screenshot/methods/get' + insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/browser/methods/delete' + delete: [] replace: [] - json: - id: cloudflare.browser_rendering.json - name: json - title: Json + snapshot: + id: cloudflare.browser_rendering.snapshot + name: snapshot + title: Snapshot methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create: + get: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1json/post' + $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1snapshot/post' response: mediaType: application/json openAPIDocKey: '200' @@ -6362,21 +6498,17 @@ components: {{- if .cookies }}{{ $sep }}"cookies": {{ if eq (kindOf .cookies) "string" }}{{ .cookies }}{{ else }}{{ toJson .cookies }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .custom_ai }}{{ $sep }}"custom_ai": {{ if eq (kindOf .custom_ai) "string" }}{{ .custom_ai }}{{ else }}{{ toJson .custom_ai }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .emulateMediaType }}{{ $sep }}"emulateMediaType": {{ toJson .emulateMediaType }}{{- $sep = "," -}}{{ end }} {{- if .gotoOptions }}{{ $sep }}"gotoOptions": {{ if eq (kindOf .gotoOptions) "string" }}{{ .gotoOptions }}{{ else }}{{ toJson .gotoOptions }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .html }}{{ $sep }}"html": {{ toJson .html }}{{- $sep = "," -}}{{ end }} - {{- if .prompt }}{{ $sep }}"prompt": {{ toJson .prompt }}{{- $sep = "," -}}{{ end }} - {{- if .rejectRequestPattern }}{{ $sep }}"rejectRequestPattern": {{ if eq (kindOf .rejectRequestPattern) "string" }}{{ .rejectRequestPattern }}{{ else }}{{ toJson .rejectRequestPattern }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .rejectResourceTypes }}{{ $sep }}"rejectResourceTypes": {{ if eq (kindOf .rejectResourceTypes) "string" }}{{ .rejectResourceTypes }}{{ else }}{{ toJson .rejectResourceTypes }}{{ end }}{{- $sep = "," -}}{{ end }} - {{- if .response_format }}{{ $sep }}"response_format": {{ if eq (kindOf .response_format) "string" }}{{ .response_format }}{{ else }}{{ toJson .response_format }}{{ end }}{{- $sep = "," -}}{{ end }} + {{- if .screenshotOptions }}{{ $sep }}"screenshotOptions": {{ if eq (kindOf .screenshotOptions) "string" }}{{ .screenshotOptions }}{{ else }}{{ toJson .screenshotOptions }}{{ end }}{{- $sep = "," -}}{{ end }} {{- if .setExtraHTTPHeaders }}{{ $sep }}"setExtraHTTPHeaders": {{ if eq (kindOf .setExtraHTTPHeaders) "string" }}{{ .setExtraHTTPHeaders }}{{ else }}{{ toJson .setExtraHTTPHeaders }}{{ end }}{{- $sep = "," -}}{{ end }} @@ -6397,151 +6529,7 @@ components: ' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/json/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/json/methods/create' - update: [] - delete: [] - replace: [] - json_activate: - id: cloudflare.browser_rendering.json_activate - name: json_activate - title: Json Activate - methods: - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1activate~1{target_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/json_activate/methods/get' - insert: [] - update: [] - delete: [] - replace: [] - json_close: - id: cloudflare.browser_rendering.json_close - name: json_close - title: Json Close - methods: - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1close~1{target_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/json_close/methods/get' - insert: [] - update: [] - delete: [] - replace: [] - targets: - id: cloudflare.browser_rendering.targets - name: targets - title: Targets - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - create: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1new/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/targets/methods/list' - insert: [] - update: [] - delete: [] - replace: - - $ref: '#/components/x-stackQL-resources/targets/methods/create' - json_list: - id: cloudflare.browser_rendering.json_list - name: json_list - title: Json List - methods: - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1list~1{target_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/json_list/methods/get' - insert: [] - update: [] - delete: [] - replace: [] - json_protocol: - id: cloudflare.browser_rendering.json_protocol - name: json_protocol - title: Json Protocol - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1protocol/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.domains - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/json_protocol/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - json_version: - id: cloudflare.browser_rendering.json_version - name: json_version - title: Json Version - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1browser~1{session_id}~1json~1version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/json_version/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - session: - id: cloudflare.browser_rendering.session - name: session - title: Session - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1session/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1browser-rendering~1devtools~1session~1{session_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/session/methods/get' - - $ref: '#/components/x-stackQL-resources/session/methods/list' + - $ref: '#/components/x-stackQL-resources/snapshot/methods/get' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cache.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cache.yaml index 6919fc95a0f..ea0149e934a 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cache.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cache.yaml @@ -2414,30 +2414,18 @@ components: type: apiKey description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - cache_cache_reserve: - id: cloudflare.cache.cache_cache_reserve - name: cache_cache_reserve - title: Cache Cache Reserve + cache_reserve: + id: cloudflare.cache.cache_reserve + name: cache_reserve + title: Cache Reserve methods: - list: + get: operation: $ref: '#/paths/~1zones~1{zone_id}~1cache~1cache_reserve/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cache_cache_reserve/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - cache_reserve: - id: cloudflare.cache.cache_reserve - name: cache_reserve - title: Cache Reserve - methods: edit: config: requestBodyTranslate: @@ -2447,6 +2435,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + get_clear_status: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1cache~1cache_reserve_clear/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result clear: config: requestBodyTranslate: @@ -2457,31 +2452,13 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/cache_reserve/methods/get' insert: [] update: - $ref: '#/components/x-stackQL-resources/cache_reserve/methods/edit' delete: [] replace: [] - cache_cache_reserve_clear: - id: cloudflare.cache.cache_cache_reserve_clear - name: cache_cache_reserve_clear - title: Cache Cache Reserve Clear - methods: - list: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1cache~1cache_reserve_clear/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cache_cache_reserve_clear/methods/list' - insert: [] - update: [] - delete: [] - replace: [] origin_cloud_regions: id: cloudflare.cache.origin_cloud_regions name: origin_cloud_regions diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml index 33044d59186..05617da6240 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml @@ -527,20 +527,10 @@ paths: content: application/json: schema: + type: object properties: - items: - properties: - type: - type: string - required: - - type - type: object - type: + contents: type: string - required: - - type - - items - type: object description: Returns a list of attackers. '400': content: @@ -604,30 +594,10 @@ paths: content: application/json: schema: - items: - properties: - killChain: - type: number - mitreAttack: - items: - type: string - type: array - mitreCapec: - items: - type: string - type: array - name: - type: string - shortname: - type: string - uuid: - type: string - required: - - uuid - - name - - killChain - type: object - type: array + type: object + properties: + contents: + type: string description: Returns a list of categories. '400': content: @@ -1202,27 +1172,10 @@ paths: content: application/json: schema: - items: - properties: - result: - items: - properties: - alpha3: - type: string - name: - type: string - required: - - name - - alpha3 - type: object - type: array - success: - type: string - required: - - success - - result - type: object - type: array + type: object + properties: + contents: + type: string description: Returns the long and short country code for every country. '400': content: @@ -1856,20 +1809,10 @@ paths: content: application/json: schema: - items: - properties: - isPublic: - type: boolean - name: - type: string - uuid: - type: string - required: - - uuid - - name - - isPublic - type: object - type: array + type: object + properties: + contents: + type: string description: Returns a list of dataset in an account. '400': content: @@ -3732,10 +3675,10 @@ paths: content: application/json: schema: - description: Array of mirror tag rows - items: - type: object - type: array + type: object + properties: + contents: + type: string description: Returns an array of mirrored tags. '400': content: @@ -5663,20 +5606,10 @@ paths: content: application/json: schema: + type: object properties: - items: - properties: - type: - type: string - required: - - type - type: object - type: + contents: type: string - required: - - type - - items - type: object description: Returns a list of indicator types. '400': content: @@ -8113,20 +8046,10 @@ paths: content: application/json: schema: + type: object properties: - items: - properties: - type: - type: string - required: - - type - type: object - type: + contents: type: string - required: - - type - - items - type: object description: Returns a list of target industries. '400': content: @@ -13302,7 +13225,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/attackers/methods/list' @@ -13321,37 +13247,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/events_categories/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - categories_catalog: - id: cloudflare.cloudforce_one.categories_catalog - name: categories_catalog - title: Categories Catalog - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1catalog/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/categories_catalog/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - events_categories_create: - id: cloudflare.cloudforce_one.events_categories_create - name: events_categories_create - title: Events Categories Create - methods: + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 create: config: requestBodyTranslate: @@ -13383,9 +13282,28 @@ components: ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/events_categories/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/events_categories_create/methods/create' + - $ref: '#/components/x-stackQL-resources/events_categories/methods/create' + update: [] + delete: [] + replace: [] + categories_catalog: + id: cloudflare.cloudforce_one.categories_catalog + name: categories_catalog + title: Categories Catalog + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1catalog/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/categories_catalog/methods/list' + insert: [] update: [] delete: [] replace: [] @@ -13504,7 +13422,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/countries/methods/list' @@ -13512,12 +13433,12 @@ components: update: [] delete: [] replace: [] - events_create: - id: cloudflare.cloudforce_one.events_create - name: events_create - title: Events Create + events: + id: cloudflare.cloudforce_one.events + name: events + title: Events methods: - create_by_account: + create: config: requestBodyTranslate: algorithm: naive @@ -13569,9 +13490,90 @@ components: } ' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1events~1{event_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_graphql: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1graphql/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_relate: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relate~1{event_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{dataset_id}~1delete/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + post_event_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .attacker }}{{ $sep }}"attacker": {{ toJson .attacker }}{{- $sep = "," -}}{{ end }} + + {{- if .attackerCountry }}{{ $sep }}"attackerCountry": {{ toJson .attackerCountry }}{{- $sep = "," -}}{{ end }} + + {{- if .category }}{{ $sep }}"category": {{ toJson .category }}{{- $sep = "," -}}{{ end }} + + {{- if .createdAt }}{{ $sep }}"createdAt": {{ toJson .createdAt }}{{- $sep = "," -}}{{ end }} + + {{- if .datasetId }}{{ $sep }}"datasetId": {{ toJson .datasetId }}{{- $sep = "," -}}{{ end }} + + {{- if .date }}{{ $sep }}"date": {{ toJson .date }}{{- $sep = "," -}}{{ end }} + + {{- if .event }}{{ $sep }}"event": {{ toJson .event }}{{- $sep = "," -}}{{ end }} + + {{- if .indicator }}{{ $sep }}"indicator": {{ toJson .indicator }}{{- $sep = "," -}}{{ end }} + + {{- if .indicatorType }}{{ $sep }}"indicatorType": {{ toJson .indicatorType }}{{- $sep = "," -}}{{ end }} + + {{- if .insight }}{{ $sep }}"insight": {{ toJson .insight }}{{- $sep = "," -}}{{ end }} + + {{- if .raw }}{{ $sep }}"raw": {{ if eq (kindOf .raw) "string" }}{{ .raw }}{{ else }}{{ toJson .raw }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .targetCountry }}{{ $sep }}"targetCountry": {{ toJson .targetCountry }}{{- $sep = "," -}}{{ end }} + + {{- if .targetIndustry }}{{ $sep }}"targetIndustry": {{ toJson .targetIndustry }}{{- $sep = "," -}}{{ end }} + + {{- if .tlp }}{{ $sep }}"tlp": {{ toJson .tlp }}{{- $sep = "," -}}{{ end }} + + } + + ' + create_graphql_v2: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1events~1graphql/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/events/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/events/methods/post_event_update' + - $ref: '#/components/x-stackQL-resources/events/methods/create' update: [] delete: [] replace: [] @@ -13603,6 +13605,28 @@ components: } + ' + create_relate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relate~1{event_id}~1create/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .events }}{{ $sep }}"events": {{ if eq (kindOf .events) "string" }}{{ .events }}{{ else }}{{ toJson .events }}{{ end }}{{- $sep = "," -}}{{ end }} + + } + ' create: config: @@ -13657,7 +13681,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 create: config: requestBodyTranslate: @@ -13872,97 +13899,6 @@ components: update: [] delete: [] replace: [] - events: - id: cloudflare.cloudforce_one.events - name: events - title: Events - methods: - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1events~1{event_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_graphql: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1graphql/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_relate: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relate~1{event_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_delete: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{dataset_id}~1delete/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - post_event_update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .attacker }}{{ $sep }}"attacker": {{ toJson .attacker }}{{- $sep = "," -}}{{ end }} - - {{- if .attackerCountry }}{{ $sep }}"attackerCountry": {{ toJson .attackerCountry }}{{- $sep = "," -}}{{ end }} - - {{- if .category }}{{ $sep }}"category": {{ toJson .category }}{{- $sep = "," -}}{{ end }} - - {{- if .createdAt }}{{ $sep }}"createdAt": {{ toJson .createdAt }}{{- $sep = "," -}}{{ end }} - - {{- if .datasetId }}{{ $sep }}"datasetId": {{ toJson .datasetId }}{{- $sep = "," -}}{{ end }} - - {{- if .date }}{{ $sep }}"date": {{ toJson .date }}{{- $sep = "," -}}{{ end }} - - {{- if .event }}{{ $sep }}"event": {{ toJson .event }}{{- $sep = "," -}}{{ end }} - - {{- if .indicator }}{{ $sep }}"indicator": {{ toJson .indicator }}{{- $sep = "," -}}{{ end }} - - {{- if .indicatorType }}{{ $sep }}"indicatorType": {{ toJson .indicatorType }}{{- $sep = "," -}}{{ end }} - - {{- if .insight }}{{ $sep }}"insight": {{ toJson .insight }}{{- $sep = "," -}}{{ end }} - - {{- if .raw }}{{ $sep }}"raw": {{ if eq (kindOf .raw) "string" }}{{ .raw }}{{ else }}{{ toJson .raw }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .targetCountry }}{{ $sep }}"targetCountry": {{ toJson .targetCountry }}{{- $sep = "," -}}{{ end }} - - {{- if .targetIndustry }}{{ $sep }}"targetIndustry": {{ toJson .targetIndustry }}{{- $sep = "," -}}{{ end }} - - {{- if .tlp }}{{ $sep }}"tlp": {{ toJson .tlp }}{{- $sep = "," -}}{{ end }} - - } - - ' - create_graphql_v2: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1events~1graphql/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/events/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/events/methods/post_event_update' - update: [] - delete: [] - replace: [] indicator_types: id: cloudflare.cloudforce_one.indicator_types name: indicator_types @@ -14167,6 +14103,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/indicators_tags/methods/list_by_account' @@ -14308,7 +14248,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/indicator_types_indicator_types/methods/list' @@ -14413,39 +14356,6 @@ components: update: [] delete: [] replace: [] - relate_create: - id: cloudflare.cloudforce_one.relate_create - name: relate_create - title: Relate Create - methods: - create_by_account: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relate~1{event_id}~1create/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .events }}{{ $sep }}"events": {{ if eq (kindOf .events) "string" }}{{ .events }}{{ else }}{{ toJson .events }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] events_tags: id: cloudflare.cloudforce_one.events_tags name: events_tags @@ -14477,18 +14387,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.categories - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/tags_categories/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - tags_categories_create: - id: cloudflare.cloudforce_one.tags_categories_create - name: tags_categories_create - title: Tags Categories Create - methods: create: config: requestBodyTranslate: @@ -14499,8 +14397,10 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/tags_categories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tags_categories/methods/create' update: [] delete: [] replace: [] @@ -14639,7 +14539,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/events_target_industries/methods/list_by_account' @@ -14811,12 +14714,12 @@ components: update: [] delete: [] replace: [] - requests_new: - id: cloudflare.cloudforce_one.requests_new - name: requests_new - title: Requests New + requests: + id: cloudflare.cloudforce_one.requests + name: requests + title: Requests methods: - new_by_account: + create: config: requestBodyTranslate: algorithm: naive @@ -14825,17 +14728,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] - requests: - id: cloudflare.cloudforce_one.requests - name: requests - title: Requests - methods: create_priority: config: requestBodyTranslate: @@ -14888,7 +14780,8 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/requests/methods/get' - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/requests/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/requests/methods/delete' @@ -15067,12 +14960,12 @@ components: - $ref: '#/components/x-stackQL-resources/assets/methods/delete' replace: - $ref: '#/components/x-stackQL-resources/assets/methods/update' - message_new: - id: cloudflare.cloudforce_one.message_new - name: message_new - title: Message New + message: + id: cloudflare.cloudforce_one.message + name: message + title: Message methods: - new_by_account: + create: config: requestBodyTranslate: algorithm: naive @@ -15081,17 +14974,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] - message: - id: cloudflare.cloudforce_one.message - name: message - title: Message - methods: delete: operation: $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1message~1{message_id}/delete' @@ -15109,7 +14991,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/message/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/message/methods/delete' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/content_scanning.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/content_scanning.yaml index 6f0baecd4c1..b2181da5de5 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/content_scanning.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/content_scanning.yaml @@ -612,10 +612,10 @@ components: your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - content_upload_scan: - id: cloudflare.content_scanning.content_upload_scan - name: content_upload_scan - title: Content Upload Scan + settings: + id: cloudflare.content_scanning.settings + name: settings + title: Settings methods: disable: operation: @@ -629,12 +629,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' insert: [] update: [] delete: [] - replace: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/create' payloads: id: cloudflare.content_scanning.payloads name: payloads @@ -674,32 +692,3 @@ components: - $ref: >- #/components/x-stackQL-resources/payloads/methods/waf_content_scanning_delete_custom_scan_expressions replace: [] - settings: - id: cloudflare.content_scanning.settings - name: settings - title: Settings - methods: - list: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1settings/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings/methods/list' - insert: [] - update: [] - delete: [] - replace: - - $ref: '#/components/x-stackQL-resources/settings/methods/create' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/d1.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/d1.yaml index e88a57469eb..344b8e37bb6 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/d1.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/d1.yaml @@ -1066,9 +1066,9 @@ paths: - database - time_travel method: restore - /graphql/d1_analytics_adaptive_groups: + /graphql/analytics_adaptive_groups: post: - operationId: graphql-d1_analytics_adaptive_groups-list + operationId: graphql-analytics_adaptive_groups-list summary: Cloudflare D1 database analytics for an account, grouped by database, serving instance, and region description: Cloudflare D1 database analytics for an account, grouped by database, serving instance, and region. Per-tuple totals for request count, read/write query counts, rows read/written, and response bytes. x-stackQL-graphQL: @@ -1701,9 +1701,9 @@ components: ' sqlVerbs: - select: [] - insert: + select: - $ref: '#/components/x-stackQL-resources/database_query/methods/query' + insert: [] update: [] delete: [] replace: [] @@ -1732,14 +1732,14 @@ components: update: [] delete: [] replace: [] - d1_analytics_adaptive_groups: - id: cloudflare.d1.d1_analytics_adaptive_groups - name: d1_analytics_adaptive_groups - title: D1 Analytics Adaptive Groups + analytics_adaptive_groups: + id: cloudflare.d1.analytics_adaptive_groups + name: analytics_adaptive_groups + title: Analytics Adaptive Groups methods: list: operation: - $ref: '#/paths/~1graphql~1d1_analytics_adaptive_groups/post' + $ref: '#/paths/~1graphql~1analytics_adaptive_groups/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1751,7 +1751,7 @@ components: x-stackql-protocol: graphql sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/d1_analytics_adaptive_groups/methods/list' + - $ref: '#/components/x-stackQL-resources/analytics_adaptive_groups/methods/list' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/diagnostics.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/diagnostics.yaml index b8b7b9fdb25..0f81e8c69cd 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/diagnostics.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/diagnostics.yaml @@ -832,7 +832,8 @@ components: ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/diagnostics/methods/create_traceroute' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns.yaml index 08b395d4204..53e8dc320f5 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns.yaml @@ -5493,9 +5493,9 @@ paths: free: true pro: true operationId: get_zones_zone_id_dns_records_usage - /graphql/dns_analytics_adaptive_groups: + /graphql/analytics_adaptive_groups: post: - operationId: graphql-dns_analytics_adaptive_groups-list + operationId: graphql-analytics_adaptive_groups-list summary: DNS query analytics for a zone, grouped by query name, type, response code, cache status, and serving colo description: DNS query analytics for a zone, grouped by query name, type, response code, cache status, and serving colo. Replaces the deprecated REST endpoints /zones/{zone_id}/dns_analytics/* (hard EOL 2026-12-01). x-stackQL-graphQL: @@ -8579,10 +8579,10 @@ components: update: [] delete: [] replace: [] - bytimes: - id: cloudflare.dns.bytimes - name: bytimes - title: Bytimes + reports_by_times: + id: cloudflare.dns.reports_by_times + name: reports_by_times + title: Reports By Times methods: list: operation: @@ -8593,7 +8593,7 @@ components: objectKey: $.result.data sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/bytimes/methods/list' + - $ref: '#/components/x-stackQL-resources/reports_by_times/methods/list' insert: [] update: [] delete: [] @@ -9253,14 +9253,14 @@ components: update: [] delete: [] replace: [] - dns_analytics_adaptive_groups: - id: cloudflare.dns.dns_analytics_adaptive_groups - name: dns_analytics_adaptive_groups - title: Dns Analytics Adaptive Groups + analytics_adaptive_groups: + id: cloudflare.dns.analytics_adaptive_groups + name: analytics_adaptive_groups + title: Analytics Adaptive Groups methods: list: operation: - $ref: '#/paths/~1graphql~1dns_analytics_adaptive_groups/post' + $ref: '#/paths/~1graphql~1analytics_adaptive_groups/post' response: mediaType: application/json openAPIDocKey: '200' @@ -9272,7 +9272,7 @@ components: x-stackql-protocol: graphql sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dns_analytics_adaptive_groups/methods/list' + - $ref: '#/components/x-stackQL-resources/analytics_adaptive_groups/methods/list' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns_firewall.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns_firewall.yaml index 16cf81a0e26..e2f81ac2c80 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns_firewall.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/dns_firewall.yaml @@ -1761,10 +1761,10 @@ components: update: [] delete: [] replace: [] - bytimes: - id: cloudflare.dns_firewall.bytimes - name: bytimes - title: Bytimes + dimensions_and_metrics: + id: cloudflare.dns_firewall.dimensions_and_metrics + name: dimensions_and_metrics + title: Dimensions And Metrics methods: list: operation: @@ -1776,7 +1776,8 @@ components: objectKey: $.result.data sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/bytimes/methods/list' + - $ref: >- + #/components/x-stackQL-resources/dimensions_and_metrics/methods/list insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/email_security.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/email_security.yaml index 2d6827ab7ab..5d6d2239b40 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/email_security.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/email_security.yaml @@ -5406,45 +5406,7 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - release: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate~1release/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - reclassify: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1reclassify/post' - response: - mediaType: application/json - openAPIDocKey: '202' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/investigate/methods/get' - - $ref: '#/components/x-stackQL-resources/investigate/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - move: - id: cloudflare.email_security.move - name: move - title: Move - methods: - email_security_post_bulk_move: + bulk_move: config: requestBodyTranslate: algorithm: naive @@ -5470,7 +5432,23 @@ components: } ' - email_security_post_message_move: + release: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate~1release/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + move_message: config: requestBodyTranslate: algorithm: naive @@ -5479,11 +5457,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + reclassify: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1reclassify/post' + response: + mediaType: application/json + openAPIDocKey: '202' sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/move/methods/email_security_post_message_move' - - $ref: '#/components/x-stackQL-resources/move/methods/email_security_post_bulk_move' + select: + - $ref: '#/components/x-stackQL-resources/investigate/methods/get' + - $ref: '#/components/x-stackQL-resources/investigate/methods/list' + insert: [] update: [] delete: [] replace: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/images.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/images.yaml index 7de712c5c7a..7fd15fde3d6 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/images.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/images.yaml @@ -1967,10 +1967,10 @@ components: type: apiKey description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - v1: - id: cloudflare.images.v1 - name: v1 - title: V1 + images_v1: + id: cloudflare.images.images_v1 + name: images_v1 + title: Images V1 methods: list: operation: @@ -2052,14 +2052,14 @@ components: ' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/v1/methods/get' - - $ref: '#/components/x-stackQL-resources/v1/methods/list' + - $ref: '#/components/x-stackQL-resources/images_v1/methods/get' + - $ref: '#/components/x-stackQL-resources/images_v1/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/v1/methods/create' + - $ref: '#/components/x-stackQL-resources/images_v1/methods/create' update: - - $ref: '#/components/x-stackQL-resources/v1/methods/edit' + - $ref: '#/components/x-stackQL-resources/images_v1/methods/edit' delete: - - $ref: '#/components/x-stackQL-resources/v1/methods/delete' + - $ref: '#/components/x-stackQL-resources/images_v1/methods/delete' replace: [] keys: id: cloudflare.images.keys @@ -2240,10 +2240,10 @@ components: update: [] delete: [] replace: [] - v2: - id: cloudflare.images.v2 - name: v2 - title: V2 + images: + id: cloudflare.images.images + name: images + title: Images methods: list: operation: @@ -2252,18 +2252,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/v2/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - images: - id: cloudflare.images.images - name: images - title: Images - methods: create_direct_upload_v2: config: requestBodyTranslate: @@ -2295,7 +2283,8 @@ components: ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/images/methods/list' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/intel.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/intel.yaml index 4cd1ae44b3c..a0d16353029 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/intel.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/intel.yaml @@ -4663,30 +4663,18 @@ components: update: [] delete: [] replace: [] - intel_indicator_feeds: - id: cloudflare.intel.intel_indicator_feeds - name: intel_indicator_feeds - title: Intel Indicator Feeds + indicator_feeds: + id: cloudflare.intel.indicator_feeds + name: indicator_feeds + title: Indicator Feeds methods: - list_by_account: + list: operation: $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/intel_indicator_feeds/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - indicator_feeds: - id: cloudflare.intel.indicator_feeds - name: indicator_feeds - title: Indicator Feeds - methods: create: config: requestBodyTranslate: @@ -4724,6 +4712,7 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/indicator_feeds/methods/get' + - $ref: '#/components/x-stackQL-resources/indicator_feeds/methods/list' insert: - $ref: '#/components/x-stackQL-resources/indicator_feeds/methods/create' update: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/kv.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/kv.yaml index 45227a03ae0..1360c3a76ef 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/kv.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/kv.yaml @@ -1242,6 +1242,13 @@ components: example: Some Value type: string format: binary + stackqlWorkersKvValueBody: + type: object + required: + - value + properties: + value: + $ref: '#/components/schemas/workersKvValue' securitySchemes: api_email: in: header @@ -1427,11 +1434,17 @@ components: body: '[{"contents": {{ toJson . }}}]' type: golang_template_text_v0.3.0 update: - config: - requestBodyTranslate: - algorithm: naive operation: $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1values~1{key_name}/put' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersKvValueBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' response: mediaType: application/json openAPIDocKey: '200' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logpush.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logpush.yaml index 9cb49e50aaf..211066c5f6b 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logpush.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logpush.yaml @@ -2508,26 +2508,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_account' - - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_zone' - insert: - - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_account' - - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_zone' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_by_account' - - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_by_zone' - replace: - - $ref: '#/components/x-stackQL-resources/jobs/methods/update_by_account' - - $ref: '#/components/x-stackQL-resources/jobs/methods/update_by_zone' - logpush_ownership: - id: cloudflare.logpush.logpush_ownership - name: logpush_ownership - title: Logpush Ownership - methods: - create_by_account: + get_ownership_challenge_by_account: config: requestBodyTranslate: algorithm: naive @@ -2536,7 +2517,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create_by_zone: + get_ownership_challenge_by_zone: config: requestBodyTranslate: algorithm: naive @@ -2545,20 +2526,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/logpush_ownership/methods/create_by_account' - - $ref: '#/components/x-stackQL-resources/logpush_ownership/methods/create_by_zone' - update: [] - delete: [] - replace: [] - ownership_validate: - id: cloudflare.logpush.ownership_validate - name: ownership_validate - title: Ownership Validate - methods: - validate_by_account: + validate_ownership_challenge_by_account: config: requestBodyTranslate: algorithm: naive @@ -2567,7 +2535,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - validate_by_zone: + validate_ownership_challenge_by_zone: config: requestBodyTranslate: algorithm: naive @@ -2576,20 +2544,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/ownership_validate/methods/validate_by_account' - - $ref: '#/components/x-stackQL-resources/ownership_validate/methods/validate_by_zone' - update: [] - delete: [] - replace: [] - validate_destination: - id: cloudflare.logpush.validate_destination - name: validate_destination - title: Validate Destination - methods: - destination_by_account: + validate_destination_by_account: config: requestBodyTranslate: algorithm: naive @@ -2598,7 +2553,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - destination_by_zone: + validate_destination_by_zone: config: requestBodyTranslate: algorithm: naive @@ -2607,19 +2562,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/validate_destination/methods/destination_by_account' - - $ref: '#/components/x-stackQL-resources/validate_destination/methods/destination_by_zone' - update: [] - delete: [] - replace: [] - destination_exists: - id: cloudflare.logpush.destination_exists - name: destination_exists - title: Destination Exists - methods: destination_exists_by_account: config: requestBodyTranslate: @@ -2638,20 +2580,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/destination_exists/methods/destination_exists_by_account' - - $ref: '#/components/x-stackQL-resources/destination_exists/methods/destination_exists_by_zone' - update: [] - delete: [] - replace: [] - validate_origin: - id: cloudflare.logpush.validate_origin - name: validate_origin - title: Validate Origin - methods: - origin_by_account: + validate_origin_by_account: config: requestBodyTranslate: algorithm: naive @@ -2660,7 +2589,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - origin_by_zone: + validate_origin_by_zone: config: requestBodyTranslate: algorithm: naive @@ -2670,10 +2599,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_zone' insert: - - $ref: '#/components/x-stackQL-resources/validate_origin/methods/origin_by_account' - - $ref: '#/components/x-stackQL-resources/validate_origin/methods/origin_by_zone' + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_zone' update: [] - delete: [] - replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_by_zone' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logs.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logs.yaml index 399011ee76b..783314847a2 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logs.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/logs.yaml @@ -294,7 +294,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/logshareLogsResponseJsonLines' + type: object + properties: + contents: + type: string description: Get logs RayIDs response 4XX: content: @@ -357,7 +360,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/logshareLogsResponseJsonLines' + type: object + properties: + contents: + type: string description: Get logs received response 4XX: content: @@ -933,7 +939,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/lexQueryResponse' + type: object + properties: + contents: + type: string description: Query results. '400': content: @@ -989,7 +998,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/lexQueryResponse' + type: object + properties: + contents: + type: string description: Query results. '400': content: @@ -1693,6 +1705,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/rayids/methods/get' @@ -1711,6 +1727,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/received/methods/list' @@ -1942,8 +1962,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{{ range $i, $v := .result }}{{ if $i }},{{ end }}{"contents": {{ toJson $v }}}{{ end }}]' + type: golang_template_json_v0.3.0 sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/accounts_logs_explorer_query_sql/methods/create_sql' insert: [] update: [] delete: [] @@ -1962,8 +1987,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{{ range $i, $v := .result }}{{ if $i }},{{ end }}{"contents": {{ toJson $v }}}{{ end }}]' + type: golang_template_json_v0.3.0 sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/zones_logs_explorer_query_sql/methods/create_sql' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/network_interconnects.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/network_interconnects.yaml index e068c932774..06b702f0478 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/network_interconnects.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/network_interconnects.yaml @@ -458,6 +458,13 @@ paths: responses: '200': description: Generated LOA in PDF format + content: + application/json: + schema: + type: object + properties: + contents: + type: string '400': description: Bad request '404': @@ -1162,6 +1169,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/loas/methods/list' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/page_rules.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/page_rules.yaml index 150aab607f9..420087079d5 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/page_rules.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/page_rules.yaml @@ -933,10 +933,10 @@ components: type: apiKey description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - pagerules: - id: cloudflare.page_rules.pagerules - name: pagerules - title: Pagerules + page_rules: + id: cloudflare.page_rules.page_rules + name: page_rules + title: Page Rules methods: list: operation: @@ -1044,16 +1044,16 @@ components: ' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/pagerules/methods/get' - - $ref: '#/components/x-stackQL-resources/pagerules/methods/list' + - $ref: '#/components/x-stackQL-resources/page_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/page_rules/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/pagerules/methods/create' + - $ref: '#/components/x-stackQL-resources/page_rules/methods/create' update: - - $ref: '#/components/x-stackQL-resources/pagerules/methods/edit' + - $ref: '#/components/x-stackQL-resources/page_rules/methods/edit' delete: - - $ref: '#/components/x-stackQL-resources/pagerules/methods/delete' + - $ref: '#/components/x-stackQL-resources/page_rules/methods/delete' replace: - - $ref: '#/components/x-stackQL-resources/pagerules/methods/update' + - $ref: '#/components/x-stackQL-resources/page_rules/methods/update' settings: id: cloudflare.page_rules.settings name: settings diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/pipelines.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/pipelines.yaml index 1aba0c33c91..e30fdc7bd5c 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/pipelines.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/pipelines.yaml @@ -2800,10 +2800,10 @@ components: type: apiKey description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - accounts_pipelines: - id: cloudflare.pipelines.accounts_pipelines - name: accounts_pipelines - title: Accounts Pipelines + pipelines: + id: cloudflare.pipelines.pipelines + name: pipelines + title: Pipelines methods: list: operation: @@ -2838,64 +2838,6 @@ components: } ' - get_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1{pipeline_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_pipelines/methods/get_by_account' - - $ref: '#/components/x-stackQL-resources/accounts_pipelines/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_pipelines/methods/create' - update: [] - delete: [] - replace: [] - v1_pipelines: - id: cloudflare.pipelines.v1_pipelines - name: v1_pipelines - title: V1 Pipelines - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - create_v1: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines~1{pipeline_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/get_by_account' - - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/create_v1' - update: [] - delete: [] - replace: [] - pipelines: - id: cloudflare.pipelines.pipelines - name: pipelines - title: Pipelines - methods: delete_v1: operation: $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines~1{pipeline_id}/delete' @@ -2917,6 +2859,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1{pipeline_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result update: config: requestBodyTranslate: @@ -2944,14 +2893,54 @@ components: ' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_v1' - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' replace: - $ref: '#/components/x-stackQL-resources/pipelines/methods/update' + v1_pipelines: + id: cloudflare.pipelines.v1_pipelines + name: v1_pipelines + title: V1 Pipelines + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_v1: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines~1{pipeline_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/create_v1' + update: [] + delete: [] + replace: [] sinks: id: cloudflare.pipelines.sinks name: sinks diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/queues.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/queues.yaml index 907d380ce40..9225d72eaf8 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/queues.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/queues.yaml @@ -2411,6 +2411,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' + ack_messages: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1ack/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .acks }}{{ $sep }}"acks": {{ if eq (kindOf .acks) "string" }}{{ .acks }}{{ else }}{{ toJson .acks }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .retries }}{{ $sep }}"retries": {{ if eq (kindOf .retries) "string" }}{{ .retries }}{{ else }}{{ toJson .retries }}{{ end }}{{- $sep = "," -}}{{ end }} + + } + + ' batch: config: requestBodyTranslate: @@ -2444,6 +2468,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' + ack_preview_messages: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1preview~1ack/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .acks }}{{ $sep }}"acks": {{ if eq (kindOf .acks) "string" }}{{ .acks }}{{ else }}{{ toJson .acks }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .retries }}{{ $sep }}"retries": {{ if eq (kindOf .retries) "string" }}{{ .retries }}{{ else }}{{ toJson .retries }}{{ end }}{{- $sep = "," -}}{{ end }} + + } + + ' pull: config: requestBodyTranslate: @@ -2557,76 +2605,6 @@ components: - $ref: '#/components/x-stackQL-resources/consumers/methods/delete' replace: - $ref: '#/components/x-stackQL-resources/consumers/methods/update' - messages_ack: - id: cloudflare.queues.messages_ack - name: messages_ack - title: Messages Ack - methods: - ack: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1ack/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .acks }}{{ $sep }}"acks": {{ if eq (kindOf .acks) "string" }}{{ .acks }}{{ else }}{{ toJson .acks }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .retries }}{{ $sep }}"retries": {{ if eq (kindOf .retries) "string" }}{{ .retries }}{{ else }}{{ toJson .retries }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] - preview_ack: - id: cloudflare.queues.preview_ack - name: preview_ack - title: Preview Ack - methods: - ack: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1preview~1ack/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .acks }}{{ $sep }}"acks": {{ if eq (kindOf .acks) "string" }}{{ .acks }}{{ else }}{{ toJson .acks }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .retries }}{{ $sep }}"retries": {{ if eq (kindOf .retries) "string" }}{{ .retries }}{{ else }}{{ toJson .retries }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] metrics: id: cloudflare.queues.metrics name: metrics diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2.yaml index 387fa2e81eb..f833c7beda1 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2.yaml @@ -2719,9 +2719,9 @@ paths: - super_slurper - connectivity_precheck method: target - /graphql/r2_operations_adaptive_groups: + /graphql/operations_adaptive_groups: post: - operationId: graphql-r2_operations_adaptive_groups-list + operationId: graphql-operations_adaptive_groups-list summary: Cloudflare R2 storage operation analytics for an account, grouped by bucket, operation type, region, and HTTP status description: Cloudflare R2 storage operation analytics for an account, grouped by bucket, operation type, region, and HTTP status. Per-tuple totals for request count, response bytes, and object size. x-stackQL-graphQL: @@ -4087,6 +4087,70 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_source_connectivity_precheck: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1source~1connectivity-precheck/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .bucket }}{{ $sep }}"bucket": {{ toJson .bucket }}{{- $sep = "," -}}{{ end }} + + {{- if .endpoint }}{{ $sep }}"endpoint": {{ toJson .endpoint }}{{- $sep = "," -}}{{ end }} + + {{- if .keys }}{{ $sep }}"keys": {{ if eq (kindOf .keys) "string" }}{{ .keys }}{{ else }}{{ toJson .keys }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .pathPrefix }}{{ $sep }}"pathPrefix": {{ toJson .pathPrefix }}{{- $sep = "," -}}{{ end }} + + {{- if .region }}{{ $sep }}"region": {{ toJson .region }}{{- $sep = "," -}}{{ end }} + + {{- if .secret }}{{ $sep }}"secret": {{ if eq (kindOf .secret) "string" }}{{ .secret }}{{ else }}{{ toJson .secret }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .vendor }}{{ $sep }}"vendor": {{ toJson .vendor }}{{- $sep = "," -}}{{ end }} + + {{- if .jurisdiction }}{{ $sep }}"jurisdiction": {{ toJson .jurisdiction }}{{- $sep = "," -}}{{ end }} + + } + + ' + update_target_connectivity_precheck: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1target~1connectivity-precheck/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .bucket }}{{ $sep }}"bucket": {{ toJson .bucket }}{{- $sep = "," -}}{{ end }} + + {{- if .jurisdiction }}{{ $sep }}"jurisdiction": {{ toJson .jurisdiction }}{{- $sep = "," -}}{{ end }} + + {{- if .secret }}{{ $sep }}"secret": {{ if eq (kindOf .secret) "string" }}{{ .secret }}{{ else }}{{ toJson .secret }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .vendor }}{{ $sep }}"vendor": {{ toJson .vendor }}{{- $sep = "," -}}{{ end }} + + } + + ' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/buckets/methods/get' @@ -4628,100 +4692,14 @@ components: update: [] delete: [] replace: [] - source_connectivity_precheck: - id: cloudflare.r2.source_connectivity_precheck - name: source_connectivity_precheck - title: Source Connectivity Precheck - methods: - update_connectivity_precheck: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1slurper~1source~1connectivity-precheck/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .bucket }}{{ $sep }}"bucket": {{ toJson .bucket }}{{- $sep = "," -}}{{ end }} - - {{- if .endpoint }}{{ $sep }}"endpoint": {{ toJson .endpoint }}{{- $sep = "," -}}{{ end }} - - {{- if .keys }}{{ $sep }}"keys": {{ if eq (kindOf .keys) "string" }}{{ .keys }}{{ else }}{{ toJson .keys }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .pathPrefix }}{{ $sep }}"pathPrefix": {{ toJson .pathPrefix }}{{- $sep = "," -}}{{ end }} - - {{- if .region }}{{ $sep }}"region": {{ toJson .region }}{{- $sep = "," -}}{{ end }} - - {{- if .secret }}{{ $sep }}"secret": {{ if eq (kindOf .secret) "string" }}{{ .secret }}{{ else }}{{ toJson .secret }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .vendor }}{{ $sep }}"vendor": {{ toJson .vendor }}{{- $sep = "," -}}{{ end }} - - {{- if .jurisdiction }}{{ $sep }}"jurisdiction": {{ toJson .jurisdiction }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] - target_connectivity_precheck: - id: cloudflare.r2.target_connectivity_precheck - name: target_connectivity_precheck - title: Target Connectivity Precheck - methods: - update_connectivity_precheck: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1slurper~1target~1connectivity-precheck/put' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .bucket }}{{ $sep }}"bucket": {{ toJson .bucket }}{{- $sep = "," -}}{{ end }} - - {{- if .jurisdiction }}{{ $sep }}"jurisdiction": {{ toJson .jurisdiction }}{{- $sep = "," -}}{{ end }} - - {{- if .secret }}{{ $sep }}"secret": {{ if eq (kindOf .secret) "string" }}{{ .secret }}{{ else }}{{ toJson .secret }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .vendor }}{{ $sep }}"vendor": {{ toJson .vendor }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] - r2_operations_adaptive_groups: - id: cloudflare.r2.r2_operations_adaptive_groups - name: r2_operations_adaptive_groups - title: R2 Operations Adaptive Groups + operations_adaptive_groups: + id: cloudflare.r2.operations_adaptive_groups + name: operations_adaptive_groups + title: Operations Adaptive Groups methods: list: operation: - $ref: '#/paths/~1graphql~1r2_operations_adaptive_groups/post' + $ref: '#/paths/~1graphql~1operations_adaptive_groups/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4733,7 +4711,7 @@ components: x-stackql-protocol: graphql sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/r2_operations_adaptive_groups/methods/list' + - $ref: '#/components/x-stackQL-resources/operations_adaptive_groups/methods/list' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml index 3cc9e351852..9e297d8735e 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml @@ -1597,12 +1597,12 @@ components: update: [] delete: [] replace: [] - r2_catalog_maintenance_configs: - id: cloudflare.r2_data_catalog.r2_catalog_maintenance_configs - name: r2_catalog_maintenance_configs - title: R2 Catalog Maintenance Configs + maintenance_configs: + id: cloudflare.r2_data_catalog.maintenance_configs + name: maintenance_configs + title: Maintenance Configs methods: - list_by_account: + list: operation: $ref: >- #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1maintenance-configs/get @@ -1610,7 +1610,7 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - update_by_account: + update: config: requestBodyTranslate: algorithm: naive @@ -1622,11 +1622,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/r2_catalog_maintenance_configs/methods/list_by_account + - $ref: '#/components/x-stackQL-resources/maintenance_configs/methods/list' insert: - $ref: >- - #/components/x-stackQL-resources/r2_catalog_maintenance_configs/methods/update_by_account + #/components/x-stackQL-resources/maintenance_configs/methods/update update: [] delete: [] replace: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/radar.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/radar.yaml index d459e9c19e9..042f53eddfb 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/radar.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/radar.yaml @@ -72829,30 +72829,18 @@ components: update: [] delete: [] replace: [] - bots_summary_user_agent: - id: cloudflare.radar.bots_summary_user_agent - name: bots_summary_user_agent - title: Bots Summary User Agent + ai_bots_summary: + id: cloudflare.radar.ai_bots_summary + name: ai_bots_summary + title: Ai Bots Summary methods: - list: + list_by_user_agent: operation: $ref: '#/paths/~1radar~1ai~1bots~1summary~1user_agent/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bots_summary_user_agent/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - bots_summary_dimension_7adba9: - id: cloudflare.radar.bots_summary_dimension_7adba9 - name: bots_summary_dimension_7adba9 - title: Bots Summary Dimension 7adba9 - methods: get: operation: $ref: '#/paths/~1radar~1ai~1bots~1summary~1{dimension}/get' @@ -72862,7 +72850,8 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/bots_summary_dimension_7adba9/methods/get' + - $ref: '#/components/x-stackQL-resources/ai_bots_summary/methods/get' + - $ref: '#/components/x-stackQL-resources/ai_bots_summary/methods/list_by_user_agent' insert: [] update: [] delete: [] @@ -72886,30 +72875,18 @@ components: update: [] delete: [] replace: [] - bots_timeseries_groups_user_agent: - id: cloudflare.radar.bots_timeseries_groups_user_agent - name: bots_timeseries_groups_user_agent - title: Bots Timeseries Groups User Agent + ai_bots_timeseries_groups: + id: cloudflare.radar.ai_bots_timeseries_groups + name: ai_bots_timeseries_groups + title: Ai Bots Timeseries Groups methods: - list: + list_by_user_agent: operation: $ref: '#/paths/~1radar~1ai~1bots~1timeseries_groups~1user_agent/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups_user_agent/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - bots_timeseries_groups_dimension_5dbf28: - id: cloudflare.radar.bots_timeseries_groups_dimension_5dbf28 - name: bots_timeseries_groups_dimension_5dbf28 - title: Bots Timeseries Groups Dimension 5dbf28 - methods: get: operation: $ref: '#/paths/~1radar~1ai~1bots~1timeseries_groups~1{dimension}/get' @@ -72919,7 +72896,8 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups_dimension_5dbf28/methods/get' + - $ref: '#/components/x-stackQL-resources/ai_bots_timeseries_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/ai_bots_timeseries_groups/methods/list_by_user_agent' insert: [] update: [] delete: [] @@ -74672,10 +74650,10 @@ components: update: [] delete: [] replace: [] - radar_bots: - id: cloudflare.radar.radar_bots - name: radar_bots - title: Radar Bots + bots: + id: cloudflare.radar.bots + name: bots + title: Bots methods: list: operation: @@ -74684,9 +74662,17 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result.bots + get: + operation: + $ref: '#/paths/~1radar~1bots~1{bot_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/radar_bots/methods/list' + - $ref: '#/components/x-stackQL-resources/bots/methods/get' + - $ref: '#/components/x-stackQL-resources/bots/methods/list' insert: [] update: [] delete: [] @@ -74729,10 +74715,10 @@ components: update: [] delete: [] replace: [] - bots_summary_dimension_f85b26: - id: cloudflare.radar.bots_summary_dimension_f85b26 - name: bots_summary_dimension_f85b26 - title: Bots Summary Dimension F85b26 + bots_summary: + id: cloudflare.radar.bots_summary + name: bots_summary + title: Bots Summary methods: get: operation: @@ -74743,7 +74729,7 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/bots_summary_dimension_f85b26/methods/get' + - $ref: '#/components/x-stackQL-resources/bots_summary/methods/get' insert: [] update: [] delete: [] @@ -74767,10 +74753,10 @@ components: update: [] delete: [] replace: [] - bots_timeseries_groups_dimension_42beed: - id: cloudflare.radar.bots_timeseries_groups_dimension_42beed - name: bots_timeseries_groups_dimension_42beed - title: Bots Timeseries Groups Dimension 42beed + bots_timeseries_groups: + id: cloudflare.radar.bots_timeseries_groups + name: bots_timeseries_groups + title: Bots Timeseries Groups methods: get: operation: @@ -74781,26 +74767,7 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups_dimension_42beed/methods/get' - insert: [] - update: [] - delete: [] - replace: [] - bots: - id: cloudflare.radar.bots - name: bots - title: Bots - methods: - get: - operation: - $ref: '#/paths/~1radar~1bots~1{bot_slug}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bots/methods/get' + - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups/methods/get' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/registrar.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/registrar.yaml index 66e7451c788..b4c2d7e87e6 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/registrar.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/registrar.yaml @@ -1580,7 +1580,8 @@ components: ' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/registrar/methods/create_domain_check' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/resource_tagging.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/resource_tagging.yaml index d1eeb0dc094..38c46e570a8 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/resource_tagging.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/resource_tagging.yaml @@ -207,7 +207,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceTaggingTagKeysResponseCollection' + type: object + properties: + key: + type: string description: List tag keys response. 4XX: content: @@ -336,7 +339,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceTaggingTagValuesResponseCollection' + type: object + properties: + value: + type: string description: List tag values response. 4XX: content: @@ -993,7 +999,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{{ range $i, $v := .result }}{{ if $i }},{{ end }}{"key": {{ toJson $v }}}{{ end }}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/keys/methods/list' @@ -1031,7 +1040,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{{ range $i, $v := .result }}{{ if $i }},{{ end }}{"value": {{ toJson $v }}}{{ end }}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/values/methods/get' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/rulesets.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/rulesets.yaml index 3b76e506a8c..c55aee3f687 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/rulesets.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/rulesets.yaml @@ -5723,8 +5723,24 @@ components: response: mediaType: application/json openAPIDocKey: '204' + list_rules_by_tag_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_rules_by_tag_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/list_rules_by_tag_by_account' + - $ref: '#/components/x-stackQL-resources/rulesets/methods/list_rules_by_tag_by_zone' - $ref: '#/components/x-stackQL-resources/rulesets/methods/get_by_account' - $ref: '#/components/x-stackQL-resources/rulesets/methods/get_by_zone' - $ref: '#/components/x-stackQL-resources/rulesets/methods/list_by_account' @@ -6060,10 +6076,10 @@ components: - $ref: '#/components/x-stackQL-resources/rules/methods/delete_by_account' - $ref: '#/components/x-stackQL-resources/rules/methods/delete_by_zone' replace: [] - rulesets_versions: - id: cloudflare.rulesets.rulesets_versions - name: rulesets_versions - title: Rulesets Versions + versions: + id: cloudflare.rulesets.versions + name: versions + title: Versions methods: list_by_account: operation: @@ -6086,6 +6102,12 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' get_by_zone: operation: $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get' @@ -6093,27 +6115,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/rulesets_versions/methods/get_by_account' - - $ref: '#/components/x-stackQL-resources/rulesets_versions/methods/get_by_zone' - - $ref: '#/components/x-stackQL-resources/rulesets_versions/methods/list_by_account' - - $ref: '#/components/x-stackQL-resources/rulesets_versions/methods/list_by_zone' - insert: [] - update: [] - delete: [] - replace: [] - versions: - id: cloudflare.rulesets.versions - name: versions - title: Versions - methods: - delete_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete' - response: - mediaType: application/json - openAPIDocKey: '204' delete_by_zone: operation: $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete' @@ -6121,37 +6122,14 @@ components: mediaType: application/json openAPIDocKey: '204' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/versions/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/versions/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/versions/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/versions/methods/list_by_zone' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/versions/methods/delete_by_account' - $ref: '#/components/x-stackQL-resources/versions/methods/delete_by_zone' replace: [] - by_tag: - id: cloudflare.rulesets.by_tag - name: by_tag - title: By Tag - methods: - get_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - get_by_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/by_tag/methods/get_by_account' - - $ref: '#/components/x-stackQL-resources/by_tag/methods/get_by_zone' - insert: [] - update: [] - delete: [] - replace: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_center.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_center.yaml index 67fdacd231b..c010fd0c455 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_center.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_center.yaml @@ -2106,10 +2106,10 @@ components: - $ref: >- #/components/x-stackQL-resources/insights/methods/dismiss_by_account - $ref: '#/components/x-stackQL-resources/insights/methods/dismiss_by_zone' - audit_logs_6f0256: - id: cloudflare.security_center.audit_logs_6f0256 - name: audit_logs_6f0256 - title: Audit Logs 6f0256 + audit_logs: + id: cloudflare.security_center.audit_logs + name: audit_logs + title: Audit Logs methods: list_by_account: operation: @@ -2119,19 +2119,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/audit_logs_6f0256/methods/list_by_account - insert: [] - update: [] - delete: [] - replace: [] - audit_logs_bff19a: - id: cloudflare.security_center.audit_logs_bff19a - name: audit_logs_bff19a - title: Audit Logs Bff19a - methods: list_by_zone: operation: $ref: >- @@ -2140,10 +2127,31 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result + list_by_account_issue: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1{issue_id}~1audit-log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone_issue: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1security-center~1insights~1{issue_id}~1audit-log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/audit_logs_bff19a/methods/list_by_zone + #/components/x-stackQL-resources/audit_logs/methods/list_by_account_issue + - $ref: >- + #/components/x-stackQL-resources/audit_logs/methods/list_by_zone_issue + - $ref: >- + #/components/x-stackQL-resources/audit_logs/methods/list_by_account + - $ref: '#/components/x-stackQL-resources/audit_logs/methods/list_by_zone' insert: [] update: [] delete: [] @@ -2284,48 +2292,6 @@ components: update: [] delete: [] replace: [] - audit_logs_8c2f64: - id: cloudflare.security_center.audit_logs_8c2f64 - name: audit_logs_8c2f64 - title: Audit Logs 8c2f64 - methods: - list_by_account: - operation: - $ref: >- - #/paths/~1accounts~1{account_id}~1security-center~1insights~1{issue_id}~1audit-log/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/audit_logs_8c2f64/methods/list_by_account - insert: [] - update: [] - delete: [] - replace: [] - audit_logs_e60d54: - id: cloudflare.security_center.audit_logs_e60d54 - name: audit_logs_e60d54 - title: Audit Logs E60d54 - methods: - list_by_zone: - operation: - $ref: >- - #/paths/~1zones~1{zone_id}~1security-center~1insights~1{issue_id}~1audit-log/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/audit_logs_e60d54/methods/list_by_zone - insert: [] - update: [] - delete: [] - replace: [] classification: id: cloudflare.security_center.classification name: classification diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_txt.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_txt.yaml index 0146aadd3e2..699b6b85c26 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_txt.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/security_txt.yaml @@ -302,10 +302,10 @@ components: type: apiKey description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - securitytxt: - id: cloudflare.security_txt.securitytxt - name: securitytxt - title: Securitytxt + security_txt: + id: cloudflare.security_txt.security_txt + name: security_txt + title: Security Txt methods: delete: operation: @@ -360,10 +360,10 @@ components: ' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/securitytxt/methods/list' + - $ref: '#/components/x-stackQL-resources/security_txt/methods/list' insert: [] update: [] delete: - - $ref: '#/components/x-stackQL-resources/securitytxt/methods/delete' + - $ref: '#/components/x-stackQL-resources/security_txt/methods/delete' replace: - - $ref: '#/components/x-stackQL-resources/securitytxt/methods/update' + - $ref: '#/components/x-stackQL-resources/security_txt/methods/update' diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/speed.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/speed.yaml index d42f6a36285..a66130fcdae 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/speed.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/speed.yaml @@ -1249,10 +1249,10 @@ components: update: [] delete: [] replace: [] - speed_api_pages: - id: cloudflare.speed.speed_api_pages - name: speed_api_pages - title: Speed Api Pages + api_pages: + id: cloudflare.speed.api_pages + name: api_pages + title: Api Pages methods: list_by_zone: operation: @@ -1263,8 +1263,7 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/speed_api_pages/methods/list_by_zone + - $ref: '#/components/x-stackQL-resources/api_pages/methods/list_by_zone' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ssl.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ssl.yaml index 6e4786479f3..b15cd6c8527 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ssl.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/ssl.yaml @@ -38,7 +38,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificateAnalyzeResponse' + type: object + properties: + contents: + type: string description: Analyze Certificate response 4XX: content: @@ -1986,8 +1989,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/ssl/methods/create_analyze' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/token_validation.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/token_validation.yaml index 757c6d02d30..0c0848cd8d2 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/token_validation.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/token_validation.yaml @@ -1806,6 +1806,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' + bulk_edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1bulk/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1bulk/post' + response: + mediaType: application/json + openAPIDocKey: '200' preview: config: requestBodyTranslate: @@ -1888,34 +1906,3 @@ components: delete: - $ref: '#/components/x-stackQL-resources/rules/methods/delete' replace: [] - bulk: - id: cloudflare.token_validation.bulk - name: bulk - title: Bulk - methods: - token_validation_rules_bulk_edit: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1bulk/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - token_validation_rules_bulk_create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1bulk/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/bulk/methods/token_validation_rules_bulk_create' - update: - - $ref: '#/components/x-stackQL-resources/bulk/methods/token_validation_rules_bulk_edit' - delete: [] - replace: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/vectorize.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/vectorize.yaml index 9b062175327..4a070f1db9f 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/vectorize.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/vectorize.yaml @@ -2852,12 +2852,12 @@ components: delete: - $ref: '#/components/x-stackQL-resources/vectorize_indexes/methods/vectorize_deprecated_delete_vectorize_index' replace: [] - vectorize: - id: cloudflare.vectorize.vectorize - name: vectorize - title: Vectorize + indexes: + id: cloudflare.vectorize.indexes + name: indexes + title: Indexes methods: - update_indexes: + update_index: config: requestBodyTranslate: algorithm: naive @@ -2866,17 +2866,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] - indexes: - id: cloudflare.vectorize.indexes - name: indexes - title: Indexes - methods: create_delete_by_ids: config: requestBodyTranslate: @@ -3062,7 +3051,8 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/indexes/methods/query_v2' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workers.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workers.yaml index 64ae7d5d5c6..53d1276699b 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workers.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workers.yaml @@ -12587,9 +12587,9 @@ paths: resource_chain: - routes method: update - /graphql/workers_invocations: + /graphql/invocations: post: - operationId: graphql-workers_invocations-list + operationId: graphql-invocations-list summary: Cloudflare Workers invocation analytics for an account, grouped by script, status, and serving colo description: Cloudflare Workers invocation analytics for an account, grouped by script, status, and serving colo. Per-tuple totals for requests, errors, CPU time, duration (GB-s), subrequests, and response bytes. x-stackQL-graphQL: @@ -17860,49 +17860,18 @@ components: update: [] delete: [] replace: [] - builds_builds: - id: cloudflare.workers.builds_builds - name: builds_builds - title: Builds Builds - methods: - list_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/builds_builds/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - latest: - id: cloudflare.workers.latest - name: latest - title: Latest + builds: + id: cloudflare.workers.builds + name: builds + title: Builds methods: list: operation: - $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1latest/get' + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/latest/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - builds: - id: cloudflare.workers.builds - name: builds - title: Builds - methods: get: operation: $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1{build_uuid}/get' @@ -17942,14 +17911,42 @@ components: } ' + list_by_script: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{external_script_id}~1builds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/builds/methods/get' + - $ref: '#/components/x-stackQL-resources/builds/methods/list_by_script' + - $ref: '#/components/x-stackQL-resources/builds/methods/list' insert: - $ref: '#/components/x-stackQL-resources/builds/methods/create_manual_build' update: [] delete: [] replace: [] + latest: + id: cloudflare.workers.latest + name: latest + title: Latest + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1latest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/latest/methods/list' + insert: [] + update: [] + delete: [] + replace: [] logs: id: cloudflare.workers.logs name: logs @@ -18205,25 +18202,6 @@ components: delete: - $ref: '#/components/x-stackQL-resources/environment_variables/methods/delete_environment_variable' replace: [] - workers_builds: - id: cloudflare.workers.workers_builds - name: workers_builds - title: Workers Builds - methods: - list_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{external_script_id}~1builds/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/workers_builds/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] deploy_hooks: id: cloudflare.workers.deploy_hooks name: deploy_hooks @@ -18630,13 +18608,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: + list_by_dispatch_namespace: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + search: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts-search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result delete: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}/delete' @@ -18686,8 +18678,9 @@ components: ' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/scripts/methods/list' + - $ref: '#/components/x-stackQL-resources/scripts/methods/list_by_dispatch_namespace' - $ref: '#/components/x-stackQL-resources/scripts/methods/get' + - $ref: '#/components/x-stackQL-resources/scripts/methods/list' insert: [] update: [] delete: @@ -18926,44 +18919,6 @@ components: update: [] delete: [] replace: [] - workers_scripts: - id: cloudflare.workers.workers_scripts - name: workers_scripts - title: Workers Scripts - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/workers_scripts/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - workers_scripts_search: - id: cloudflare.workers.workers_scripts_search - name: workers_scripts_search - title: Workers Scripts Search - methods: - list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts-search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/workers_scripts_search/methods/list' - insert: [] - update: [] - delete: [] - replace: [] content: id: cloudflare.workers.content name: content @@ -19137,12 +19092,12 @@ components: delete: [] replace: - $ref: '#/components/x-stackQL-resources/schedules/methods/update' - scripts_script_settings: - id: cloudflare.workers.scripts_script_settings - name: scripts_script_settings - title: Scripts Script Settings + scripts_settings: + id: cloudflare.workers.scripts_settings + name: scripts_settings + title: Scripts Settings methods: - list_by_account: + get: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1script-settings/get' response: @@ -19151,7 +19106,7 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/scripts_script_settings/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/scripts_settings/methods/get' insert: [] update: [] delete: [] @@ -19338,25 +19293,25 @@ components: - $ref: '#/components/x-stackQL-resources/script_and_version_settings/methods/edit' delete: [] replace: [] - subdomain: - id: cloudflare.workers.subdomain - name: subdomain - title: Subdomain + subdomains: + id: cloudflare.workers.subdomains + name: subdomains + title: Subdomains methods: - delete: + delete_script_subdomain: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1subdomain/delete' response: mediaType: application/json openAPIDocKey: '200' - list: + get_script_subdomain: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1subdomain/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - create: + create_script_subdomain: config: requestBodyTranslate: algorithm: naive @@ -19365,15 +19320,40 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/put' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/subdomain/methods/list' + - $ref: '#/components/x-stackQL-resources/subdomains/methods/get_script_subdomain' + - $ref: '#/components/x-stackQL-resources/subdomains/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/subdomain/methods/create' + - $ref: '#/components/x-stackQL-resources/subdomains/methods/create_script_subdomain' update: [] delete: - - $ref: '#/components/x-stackQL-resources/subdomain/methods/delete' - replace: [] + - $ref: '#/components/x-stackQL-resources/subdomains/methods/delete_script_subdomain' + - $ref: '#/components/x-stackQL-resources/subdomains/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/update' tail: id: cloudflare.workers.tail name: tail @@ -19547,55 +19527,19 @@ components: update: [] delete: [] replace: [] - subdomains: - id: cloudflare.workers.subdomains - name: subdomains - title: Subdomains + versions: + id: cloudflare.workers.versions + name: versions + title: Versions methods: - delete: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/delete' - response: - mediaType: application/json - openAPIDocKey: '204' list: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/subdomains/methods/list' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/subdomains/methods/delete' - replace: - - $ref: '#/components/x-stackQL-resources/subdomains/methods/update' - workers_versions: - id: cloudflare.workers.workers_versions - name: workers_versions - title: Workers Versions - methods: - list_by_account: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}~1versions/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - create_by_account: + create: config: requestBodyTranslate: algorithm: naive @@ -19639,7 +19583,7 @@ components: } ' - get_by_account: + get: operation: $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}~1versions~1{version_id}/get' response: @@ -19648,10 +19592,10 @@ components: objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workers_versions/methods/get_by_account' - - $ref: '#/components/x-stackQL-resources/workers_versions/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/workers_versions/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/versions/methods/create' update: [] delete: [] replace: [] @@ -19709,14 +19653,14 @@ components: - $ref: '#/components/x-stackQL-resources/routes/methods/delete' replace: - $ref: '#/components/x-stackQL-resources/routes/methods/update' - workers_invocations: - id: cloudflare.workers.workers_invocations - name: workers_invocations - title: Workers Invocations + invocations: + id: cloudflare.workers.invocations + name: invocations + title: Invocations methods: list: operation: - $ref: '#/paths/~1graphql~1workers_invocations/post' + $ref: '#/paths/~1graphql~1invocations/post' response: mediaType: application/json openAPIDocKey: '200' @@ -19728,7 +19672,7 @@ components: x-stackql-protocol: graphql sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workers_invocations/methods/list' + - $ref: '#/components/x-stackQL-resources/invocations/methods/list' insert: [] update: [] delete: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workflows.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workflows.yaml index 50491817dca..2cf3a2f9727 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workflows.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/workflows.yaml @@ -3839,6 +3839,32 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + mediaType: application/json + transform: + type: golang_template_json_v0.3.0 + body: '{ + + {{- $sep := "" -}} + + {{- if .instance_id }}{{ $sep }}"instance_id": {{ toJson .instance_id }}{{- $sep = "," -}}{{ end }} + + {{- if .instance_retention }}{{ $sep }}"instance_retention": {{ if eq (kindOf .instance_retention) "string" }}{{ .instance_retention }}{{ else }}{{ toJson .instance_retention }}{{ end }}{{- $sep = "," -}}{{ end }} + + {{- if .params }}{{ $sep }}"params": {{ if eq (kindOf .params) "string" }}{{ .params }}{{ else }}{{ toJson .params }}{{ end }}{{- $sep = "," -}}{{ end }} + + } + + ' batch: config: requestBodyTranslate: @@ -3883,45 +3909,8 @@ components: select: - $ref: '#/components/x-stackQL-resources/instances/methods/get' - $ref: '#/components/x-stackQL-resources/instances/methods/list' - insert: [] - update: [] - delete: [] - replace: [] - workflows_instances: - id: cloudflare.workflows.workflows_instances - name: workflows_instances - title: Workflows Instances - methods: - create_by_account: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances/post' - response: - mediaType: application/json - openAPIDocKey: '200' - request: - mediaType: application/json - transform: - type: golang_template_json_v0.3.0 - body: '{ - - {{- $sep := "" -}} - - {{- if .instance_id }}{{ $sep }}"instance_id": {{ toJson .instance_id }}{{- $sep = "," -}}{{ end }} - - {{- if .instance_retention }}{{ $sep }}"instance_retention": {{ if eq (kindOf .instance_retention) "string" }}{{ .instance_retention }}{{ else }}{{ toJson .instance_retention }}{{ end }}{{- $sep = "," -}}{{ end }} - - {{- if .params }}{{ $sep }}"params": {{ if eq (kindOf .params) "string" }}{{ .params }}{{ else }}{{ toJson .params }}{{ end }}{{- $sep = "," -}}{{ end }} - - } - - ' - sqlVerbs: - select: [] insert: - - $ref: '#/components/x-stackQL-resources/workflows_instances/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: [] delete: [] replace: [] diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zero_trust.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zero_trust.yaml index c2919e55f40..2af6735b3dc 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zero_trust.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zero_trust.yaml @@ -10218,26 +10218,10 @@ paths: content: application/json: schema: - properties: - errors: - items: - $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' - type: array - messages: - items: - $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' - type: array - result: - $ref: '#/components/schemas/teamsDevicesOverrideCodes' - success: - description: Whether the API call was successful. - type: boolean - required: - - result - - success - - errors - - messages type: object + properties: + contents: + type: string description: Get admin override codes for a registration response. security: - api_token: [] @@ -10981,7 +10965,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/teamsDevicesOverrideCodesResponse' + type: object + properties: + contents: + type: string description: Get an admin override code for a device response. 4XX: content: @@ -46334,6 +46321,22 @@ components: readOnly: true type: string x-stainless-terraform-configurability: computed + stackqlDlpDatasetsUploadVersionBody: + type: object + required: + - value + properties: + value: + format: binary + type: string + stackqlDlpDatasetsUploadDatasetColumnBody: + type: object + required: + - value + properties: + value: + format: binary + type: string securitySchemes: api_email: in: header @@ -47893,6 +47896,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + revoke_physical_device: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1physical-devices~1{device_id}~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' delete_policy: operation: $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}/delete' @@ -47965,6 +47974,15 @@ components: } ' + revoke: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' unrevoke: config: requestBodyTranslate: @@ -48008,23 +48026,6 @@ components: update: [] delete: [] replace: [] - physical_devices_revoke: - id: cloudflare.zero_trust.physical_devices_revoke - name: physical_devices_revoke - title: Physical Devices Revoke - methods: - revoke_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1devices~1physical-devices~1{device_id}~1revoke/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] devices_policies: id: cloudflare.zero_trust.devices_policies name: devices_policies @@ -48206,10 +48207,10 @@ components: update: [] delete: [] replace: [] - excludes_9e6eed: - id: cloudflare.zero_trust.excludes_9e6eed - name: excludes_9e6eed - title: Excludes 9e6eed + excludes: + id: cloudflare.zero_trust.excludes + name: excludes + title: Excludes methods: list_by_account: operation: @@ -48218,19 +48219,7 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/excludes_9e6eed/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - exclude: - id: cloudflare.zero_trust.exclude - name: exclude - title: Exclude - methods: - devices_set_split_tunnel_exclude_list: + set: config: requestBodyTranslate: algorithm: naive @@ -48239,7 +48228,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - devices_set_split_tunnel_exclude_list_for_a_device_settings_policy: + list_by_policy: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1exclude/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + set_by_policy: config: requestBodyTranslate: algorithm: naive @@ -48249,17 +48245,19 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/excludes/methods/list_by_policy' + - $ref: '#/components/x-stackQL-resources/excludes/methods/list_by_account' insert: [] update: [] delete: [] replace: - - $ref: '#/components/x-stackQL-resources/exclude/methods/devices_set_split_tunnel_exclude_list_for_a_device_settings_policy' - - $ref: '#/components/x-stackQL-resources/exclude/methods/devices_set_split_tunnel_exclude_list' - fallback_domains_f560de: - id: cloudflare.zero_trust.fallback_domains_f560de - name: fallback_domains_f560de - title: Fallback Domains F560de + - $ref: '#/components/x-stackQL-resources/excludes/methods/set_by_policy' + - $ref: '#/components/x-stackQL-resources/excludes/methods/set' + fallback_domains: + id: cloudflare.zero_trust.fallback_domains + name: fallback_domains + title: Fallback Domains methods: list_by_account: operation: @@ -48268,19 +48266,7 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/fallback_domains_f560de/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - fallback_domains: - id: cloudflare.zero_trust.fallback_domains - name: fallback_domains - title: Fallback Domains - methods: - devices_set_local_domain_fallback_list: + set: config: requestBodyTranslate: algorithm: naive @@ -48289,7 +48275,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - devices_set_local_domain_fallback_list_for_a_device_settings_policy: + list_by_policy: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1fallback_domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + set_by_policy: config: requestBodyTranslate: algorithm: naive @@ -48299,17 +48292,19 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/list_by_policy' + - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/list_by_account' insert: [] update: [] delete: [] replace: - - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/devices_set_local_domain_fallback_list_for_a_device_settings_policy' - - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/devices_set_local_domain_fallback_list' - includes_73882e: - id: cloudflare.zero_trust.includes_73882e - name: includes_73882e - title: Includes 73882e + - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/set_by_policy' + - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/set' + includes: + id: cloudflare.zero_trust.includes + name: includes + title: Includes methods: list_by_account: operation: @@ -48318,19 +48313,7 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/includes_73882e/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - include: - id: cloudflare.zero_trust.include - name: include - title: Include - methods: - devices_set_split_tunnel_include_list: + set: config: requestBodyTranslate: algorithm: naive @@ -48339,80 +48322,32 @@ components: response: mediaType: application/json openAPIDocKey: '200' - devices_set_split_tunnel_include_list_for_a_device_settings_policy: - config: - requestBodyTranslate: - algorithm: naive + list_by_policy: operation: - $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1include/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: - - $ref: '#/components/x-stackQL-resources/include/methods/devices_set_split_tunnel_include_list_for_a_device_settings_policy' - - $ref: '#/components/x-stackQL-resources/include/methods/devices_set_split_tunnel_include_list' - excludes_26edfa: - id: cloudflare.zero_trust.excludes_26edfa - name: excludes_26edfa - title: Excludes 26edfa - methods: - list_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/excludes_26edfa/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - fallback_domains_97f458: - id: cloudflare.zero_trust.fallback_domains_97f458 - name: fallback_domains_97f458 - title: Fallback Domains 97f458 - methods: - list_by_account: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1fallback_domains/get' + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1include/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/fallback_domains_97f458/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - includes_11848d: - id: cloudflare.zero_trust.includes_11848d - name: includes_11848d - title: Includes 11848d - methods: - list_by_account: + set_by_policy: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1include/get' + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1include/put' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/includes_11848d/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/includes/methods/list_by_policy' + - $ref: '#/components/x-stackQL-resources/includes/methods/list_by_account' insert: [] update: [] delete: [] - replace: [] + replace: + - $ref: '#/components/x-stackQL-resources/includes/methods/set_by_policy' + - $ref: '#/components/x-stackQL-resources/includes/methods/set' posture: id: cloudflare.zero_trust.posture name: posture @@ -48613,6 +48548,30 @@ components: } ' + create_entry: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_entry: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration~1{entry_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update_entry: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration~1{entry_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' update: config: requestBodyTranslate: @@ -48624,11 +48583,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_entry' update: - $ref: '#/components/x-stackQL-resources/integrations/methods/edit' - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_entry' replace: + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_entry' - $ref: '#/components/x-stackQL-resources/integrations/methods/update' registrations: id: cloudflare.zero_trust.registrations @@ -48695,7 +48657,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/registrations_override_codes/methods/list_by_account' @@ -48732,26 +48697,6 @@ components: update: [] delete: [] replace: [] - devices_revoke: - id: cloudflare.zero_trust.devices_revoke - name: devices_revoke - title: Devices Revoke - methods: - revoke_by_account: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1devices~1revoke/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] devices_settings: id: cloudflare.zero_trust.devices_settings name: devices_settings @@ -48809,7 +48754,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.result + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson .result }}}]' + type: golang_template_json_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/devices_override_codes/methods/list_by_account' @@ -49374,6 +49322,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' + upload_version: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1upload/post' + response: + mediaType: application/json + openAPIDocKey: '200' + upload_version_data: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1upload~1{version}/post' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlDlpDatasetsUploadVersionBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' + response: + mediaType: application/json + openAPIDocKey: '200' dlp_datasets_define_columns: config: requestBodyTranslate: @@ -49394,45 +49363,23 @@ components: - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' replace: - $ref: '#/components/x-stackQL-resources/datasets/methods/update' - upload: - id: cloudflare.zero_trust.upload - name: upload - title: Upload - methods: - create: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1upload/post' - response: - mediaType: application/json - openAPIDocKey: '200' - edit: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1upload~1{version}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/upload/methods/edit' - - $ref: '#/components/x-stackQL-resources/upload/methods/create' - update: [] - delete: [] - replace: [] entries: id: cloudflare.zero_trust.entries name: entries title: Entries methods: create: - config: - requestBodyTranslate: - algorithm: naive operation: $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1versions~1{version}~1entries~1{entry_id}/post' + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlDlpDatasetsUploadDatasetColumnBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' response: mediaType: application/json openAPIDocKey: '200' @@ -49809,44 +49756,6 @@ components: delete: - $ref: '#/components/x-stackQL-resources/dlp_entries/methods/delete_by_account' replace: [] - integration: - id: cloudflare.zero_trust.integration - name: integration - title: Integration - methods: - create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration~1{entry_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration~1{entry_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/integration/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/integration/methods/delete' - replace: - - $ref: '#/components/x-stackQL-resources/integration/methods/update' entries_predefined: id: cloudflare.zero_trust.entries_predefined name: entries_predefined @@ -52590,10 +52499,10 @@ components: replace: - $ref: '#/components/x-stackQL-resources/applications/methods/update_by_account' - $ref: '#/components/x-stackQL-resources/applications/methods/update_by_zone' - cas_f84f2f: - id: cloudflare.zero_trust.cas_f84f2f - name: cas_f84f2f - title: Cas F84f2f + cas: + id: cloudflare.zero_trust.cas + name: cas + title: Cas methods: list_by_account: operation: @@ -52602,18 +52511,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cas_f84f2f/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - cas_c5c46c: - id: cloudflare.zero_trust.cas_c5c46c - name: cas_c5c46c - title: Cas C5c46c - methods: list_by_zone: operation: $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1ca/get' @@ -52621,37 +52518,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cas_c5c46c/methods/list_by_zone' - insert: [] - update: [] - delete: [] - replace: [] - cas_e335ab: - id: cloudflare.zero_trust.cas_e335ab - name: cas_e335ab - title: Cas E335ab - methods: - list_by_account: + get_by_account: operation: $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1ca/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cas_e335ab/methods/list_by_account' - insert: [] - update: [] - delete: [] - replace: [] - cas: - id: cloudflare.zero_trust.cas - name: cas - title: Cas - methods: create_by_account: operation: $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1ca/post' @@ -52664,6 +52537,13 @@ components: response: mediaType: application/json openAPIDocKey: '202' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1ca/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result create_by_zone: operation: $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1ca/post' @@ -52677,7 +52557,11 @@ components: mediaType: application/json openAPIDocKey: '202' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/cas/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/cas/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/cas/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/cas/methods/list_by_zone' insert: - $ref: '#/components/x-stackQL-resources/cas/methods/create_by_account' - $ref: '#/components/x-stackQL-resources/cas/methods/create_by_zone' @@ -52686,25 +52570,6 @@ components: - $ref: '#/components/x-stackQL-resources/cas/methods/delete_by_account' - $ref: '#/components/x-stackQL-resources/cas/methods/delete_by_zone' replace: [] - cas_0145fa: - id: cloudflare.zero_trust.cas_0145fa - name: cas_0145fa - title: Cas 0145fa - methods: - list_by_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cas_0145fa/methods/list_by_zone' - insert: [] - update: [] - delete: [] - replace: [] apps_policies: id: cloudflare.zero_trust.apps_policies name: apps_policies diff --git a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zones.yaml b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zones.yaml index 6ca3ca743a4..4ad56f97e75 100644 --- a/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zones.yaml +++ b/stackql_cloudflare/provider-dev/openapi/src/cloudflare/v00.00.00000/services/zones.yaml @@ -8353,19 +8353,19 @@ components: - $ref: '#/components/x-stackQL-resources/smart_shield/methods/smart_shield_patch_settings' delete: [] replace: [] - cache_reserve_clear: - id: cloudflare.zones.cache_reserve_clear - name: cache_reserve_clear - title: Cache Reserve Clear + cache_reserve: + id: cloudflare.zones.cache_reserve + name: cache_reserve + title: Cache Reserve methods: - list: + get_clear_status: operation: $ref: '#/paths/~1zones~1{zone_id}~1smart_shield~1cache_reserve_clear/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - smart_shield_settings_start_cache_reserve_clear: + start_clear: config: requestBodyTranslate: algorithm: naive @@ -8376,9 +8376,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/cache_reserve_clear/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/cache_reserve_clear/methods/smart_shield_settings_start_cache_reserve_clear' + - $ref: '#/components/x-stackQL-resources/cache_reserve/methods/get_clear_status' + insert: [] update: [] delete: [] replace: [] diff --git a/stackql_cloudflare/provider-dev/source-graphql/manifest.yaml b/stackql_cloudflare/provider-dev/source-graphql/manifest.yaml index bdedee21c08..8e7f8c4c194 100644 --- a/stackql_cloudflare/provider-dev/source-graphql/manifest.yaml +++ b/stackql_cloudflare/provider-dev/source-graphql/manifest.yaml @@ -60,28 +60,28 @@ operations: - field: dnsAnalyticsAdaptiveGroups scope: zone service: dns - resource: dns_analytics_adaptive_groups + resource: analytics_adaptive_groups method: list spec: ops/dns_analytics_adaptive_groups.yaml - field: workersInvocationsAdaptive scope: account service: workers - resource: workers_invocations + resource: invocations method: list spec: ops/workers_invocations_adaptive.yaml - field: r2OperationsAdaptiveGroups scope: account service: r2 - resource: r2_operations_adaptive_groups + resource: operations_adaptive_groups method: list spec: ops/r2_operations_adaptive_groups.yaml - field: d1AnalyticsAdaptiveGroups scope: account service: d1 - resource: d1_analytics_adaptive_groups + resource: analytics_adaptive_groups method: list spec: ops/d1_analytics_adaptive_groups.yaml diff --git a/stackql_cloudflare/provider-dev/source/aisearch.yaml b/stackql_cloudflare/provider-dev/source/ai_search.yaml similarity index 97% rename from stackql_cloudflare/provider-dev/source/aisearch.yaml rename to stackql_cloudflare/provider-dev/source/ai_search.yaml index 7029f441006..2cce8ce134d 100644 --- a/stackql_cloudflare/provider-dev/source/aisearch.yaml +++ b/stackql_cloudflare/provider-dev/source/ai_search.yaml @@ -1,15477 +1,15477 @@ -openapi: 3.0.3 -info: - title: aisearch API - description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), - but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). - version: 4.0.0 - contact: - name: Cloudflare - url: https://www.cloudflare.com -servers: -- description: Client API - url: https://api.cloudflare.com/client/v4 -security: -- api_token: [] -paths: - /accounts/{account_id}/ai-search/instances: - get: - description: List instances. - operationId: ai-search-list-instances - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - description: Page number (1-indexed). - in: query - name: page - schema: - default: 1 - description: Page number (1-indexed). - minimum: 1 - type: integer - - description: Number of results per page. - in: query - name: per_page - schema: - default: 20 - description: Number of results per page. - maximum: 100 - minimum: 1 - type: integer - - description: Filter instances whose id contains this string (case-insensitive). - in: query - name: search - schema: - description: Filter instances whose id contains this string (case-insensitive). - type: string - - description: Filter by namespace. - in: query - name: namespace - schema: - description: Filter by namespace. - type: string - - description: Field to order results by. - in: query - name: order_by - schema: - default: created_at - description: Field to order results by. - enum: - - created_at - type: string - - description: Order direction. - in: query - name: order_by_direction - schema: - default: desc - description: Order direction. - enum: - - asc - - desc - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - type: array - result_info: - properties: - count: - type: number - page: - type: number - per_page: - type: number - total_count: - type: number - required: - - page - - per_page - - count - - total_count - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - - result_info - type: object - description: List of instances. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List instances. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: list - post: - description: Create a new instance. - operationId: ai-search-create-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk: - default: true - type: boolean - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - type: object - responses: - '201': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the new instance. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search instance invalid token. - '403': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Max instances reached. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create new instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: create - /accounts/{account_id}/ai-search/instances/{id}: - delete: - description: Delete instance. - operationId: ai-search-delete-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the deleted instance. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Delete instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: delete - get: - description: Read instance. - operationId: ai-search-fetch-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the instance. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Read instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: read - put: - description: Update instance. - operationId: ai-search-update-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk: - default: true - type: boolean - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - summarization: - default: false - type: boolean - x-auditable: true - summarization_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - system_prompt_ai_search: - nullable: true - type: string - x-auditable: true - system_prompt_index_summarization: - nullable: true - type: string - x-auditable: true - system_prompt_rewrite_query: - nullable: true - type: string - x-auditable: true - token_id: - format: uuid - type: string - x-auditable: true - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the updated instance. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search instance invalid token. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Update instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: update - /accounts/{account_id}/ai-search/instances/{id}/chat/completions: - post: - description: Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. - operationId: ai-search-instance-chat-completion - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_search_options: - properties: - cache: - properties: - cache_threshold: - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - enabled: - type: boolean - type: object - query_rewrite: - properties: - enabled: - type: boolean - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - rewrite_prompt: - type: string - type: object - reranking: - properties: - enabled: - type: boolean - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - retrieval: - properties: - boost_by: - description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - context_expansion: - default: 0 - maximum: 3 - minimum: 0 - type: integer - filters: - type: object - fusion_method: - enum: - - max - - rrf - type: string - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - retrieval_type: - enum: - - vector - - keyword - - hybrid - type: string - return_on_failure: - default: true - type: boolean - type: object - type: object - messages: - items: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - minItems: 1 - type: array - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - stream: - type: boolean - required: - - messages - type: object - responses: - '200': - content: - application/json: - schema: - properties: - choices: - items: - properties: - index: - type: integer - message: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - required: - - message - type: object - type: array - chunks: - items: - properties: - id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - score: - maximum: 1 - minimum: 0 - type: number - scoring_details: - properties: - fusion_method: - enum: - - rrf - - max - type: string - keyword_rank: - type: number - keyword_score: - minimum: 0 - type: number - reranking_score: - maximum: 1 - minimum: 0 - type: number - vector_rank: - type: number - vector_score: - maximum: 1 - minimum: 0 - type: number - type: object - text: - type: string - type: - type: string - required: - - id - - type - - score - - text - type: object - type: array - id: - type: string - model: - type: string - object: - type: string - required: - - choices - - chunks - type: object - description: Returns the chat completions results with retrieved files. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Chat Completions - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: chat_completions - /accounts/{account_id}/ai-search/instances/{id}/jobs: - get: - description: Lists indexing jobs for an AI Search instance. - operationId: ai-search-instance-list-jobs - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 50 - minimum: 0 - type: integer - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - type: integer - total_count: - type: integer - required: - - count - - page - - per_page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns a list of AI Search Jobs. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Jobs - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - - jobs - method: list - post: - description: Creates a new indexing job for an AI Search instance. - operationId: ai-search-instance-create-job - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - description: - maxLength: 255 - type: string - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the AI Search job id. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '429': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Sync in cooldown. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create new job - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - - jobs - method: create - /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}: - get: - description: Retrieves details for a specific AI Search indexing job. - operationId: ai-search-instance-get-job - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns a AI Search Job Details. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Get a Job Details - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - - jobs - method: get - patch: - description: Updates the status of an AI Search indexing job. - operationId: ai-search-instance-change-job-status - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - action: - enum: - - cancel - type: string - required: - - action - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the updated AI Search Job. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job cannot be cancelled. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Change Job Status - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs: - get: - description: Lists log entries for an AI Search indexing job. - operationId: ai-search-instance-list-job-logs - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 500 - minimum: 0 - type: integer - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - created_at: - type: number - readOnly: true - id: - type: integer - message: - type: string - message_type: - type: integer - required: - - id - - message - - message_type - - created_at - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - type: integer - total_count: - type: integer - required: - - count - - page - - per_page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns a list of AI Search Job Logs. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Job Logs - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - - jobs - method: logs - /accounts/{account_id}/ai-search/instances/{id}/search: - post: - description: Executes a semantic search query against an AI Search instance to find relevant indexed content. - operationId: ai-search-instance-search - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_search_options: - properties: - cache: - properties: - cache_threshold: - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - enabled: - type: boolean - type: object - query_rewrite: - properties: - enabled: - type: boolean - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - rewrite_prompt: - type: string - type: object - reranking: - properties: - enabled: - type: boolean - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - retrieval: - properties: - boost_by: - description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - context_expansion: - default: 0 - maximum: 3 - minimum: 0 - type: integer - filters: - type: object - fusion_method: - enum: - - max - - rrf - type: string - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - retrieval_type: - enum: - - vector - - keyword - - hybrid - type: string - return_on_failure: - default: true - type: boolean - type: object - type: object - messages: - items: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - minItems: 1 - type: array - query: - description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." - minLength: 1 - type: string - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - chunks: - items: - properties: - id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - score: - maximum: 1 - minimum: 0 - type: number - scoring_details: - properties: - fusion_method: - enum: - - rrf - - max - type: string - keyword_rank: - type: number - keyword_score: - minimum: 0 - type: number - reranking_score: - maximum: 1 - minimum: 0 - type: number - vector_rank: - type: number - vector_score: - maximum: 1 - minimum: 0 - type: number - type: object - text: - type: string - type: - type: string - required: - - id - - type - - score - - text - type: object - type: array - search_query: - type: string - required: - - search_query - - chunks - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the search results. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Search - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: search - /accounts/{account_id}/ai-search/instances/{id}/stats: - get: - description: Retrieves usage statistics for AI Search instances. - operationId: ai-search-stats - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - completed: - type: integer - engine: - description: Engine-specific metadata. Present only for managed (v3) instances. - properties: - r2: - description: R2 bucket storage usage in bytes. - properties: - metadataSizeBytes: - type: integer - objectCount: - type: integer - payloadSizeBytes: - type: integer - required: - - payloadSizeBytes - - metadataSizeBytes - - objectCount - type: object - vectorize: - description: Vectorize index metadata (dimensions, vector count). - properties: - dimensions: - type: integer - vectorsCount: - type: integer - required: - - vectorsCount - - dimensions - type: object - type: object - error: - type: integer - file_embed_errors: - type: object - index_source_errors: - type: object - last_activity: - format: date-time - type: string - outdated: - type: integer - queued: - type: integer - running: - type: integer - skipped: - type: integer - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the AI Search stats. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Stats - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - instances - method: stats - /accounts/{account_id}/ai-search/namespaces: - get: - description: List namespaces. - operationId: ai-search-list-namespaces - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - description: Page number (1-indexed). - in: query - name: page - schema: - default: 1 - description: Page number (1-indexed). - minimum: 1 - type: integer - - description: Number of results per page. - in: query - name: per_page - schema: - default: 20 - description: Number of results per page. - maximum: 100 - minimum: 1 - type: integer - - description: Filter namespaces whose name or description contains this string (case-insensitive). - in: query - name: search - schema: - description: Filter namespaces whose name or description contains this string (case-insensitive). - maxLength: 256 - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - created_at: - format: date-time - readOnly: true - type: string - description: - description: Optional description for the namespace. Max 256 characters. - maxLength: 256 - nullable: true - type: string - name: - type: string - required: - - name - - created_at - type: object - type: array - result_info: - properties: - count: - type: number - page: - type: number - per_page: - type: number - total_count: - type: number - required: - - page - - per_page - - count - - total_count - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - - result_info - type: object - description: List of namespaces. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List namespaces. - tags: - - AI Search Namespaces - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: list - post: - description: Create a new namespace. - operationId: ai-search-create-namespace - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - description: - description: Optional description for the namespace. Max 256 characters. - maxLength: 256 - nullable: true - type: string - name: - type: string - required: - - name - type: object - responses: - '201': - content: - application/json: - schema: - properties: - result: - properties: - created_at: - format: date-time - readOnly: true - type: string - description: - description: Optional description for the namespace. Max 256 characters. - maxLength: 256 - nullable: true - type: string - name: - type: string - required: - - name - - created_at - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Namespace created. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '403': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Max namespaces reached. - '409': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Namespace already exists. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create namespace. - tags: - - AI Search Namespaces - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: create - /accounts/{account_id}/ai-search/namespaces/{name}: - delete: - description: Delete namespace. - operationId: ai-search-delete-namespace - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Namespace deleted. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Namespace not empty. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Namespace not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Delete namespace. - tags: - - AI Search Namespaces - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: delete - get: - description: Read namespace. - operationId: ai-search-fetch-namespace - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - created_at: - format: date-time - readOnly: true - type: string - description: - description: Optional description for the namespace. Max 256 characters. - maxLength: 256 - nullable: true - type: string - name: - type: string - required: - - name - - created_at - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Namespace details. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Namespace not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Read namespace. - tags: - - AI Search Namespaces - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: read - put: - description: Update namespace. - operationId: ai-search-update-namespace - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - description: - description: Optional description for the namespace. Max 256 characters. - maxLength: 256 - nullable: true - type: string - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - created_at: - format: date-time - readOnly: true - type: string - description: - description: Optional description for the namespace. Max 256 characters. - maxLength: 256 - nullable: true - type: string - name: - type: string - required: - - name - - created_at - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Returns the updated namespace. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Cannot modify default namespace. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Namespace not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Update namespace. - tags: - - AI Search Namespaces - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: update - /accounts/{account_id}/ai-search/namespaces/{name}/chat/completions: - post: - description: Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response. - operationId: ai-search-namespace-multi-instance-chat-completion - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_search_options: - properties: - cache: - properties: - cache_threshold: - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - enabled: - type: boolean - type: object - instance_ids: - items: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - minItems: 1 - type: array - query_rewrite: - properties: - enabled: - type: boolean - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - rewrite_prompt: - type: string - type: object - reranking: - properties: - enabled: - type: boolean - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - retrieval: - properties: - boost_by: - description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - context_expansion: - default: 0 - maximum: 3 - minimum: 0 - type: integer - filters: - type: object - fusion_method: - enum: - - max - - rrf - type: string - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - retrieval_type: - enum: - - vector - - keyword - - hybrid - type: string - return_on_failure: - default: true - type: boolean - type: object - required: - - instance_ids - type: object - messages: - items: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - minItems: 1 - type: array - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - stream: - type: boolean - required: - - messages - - ai_search_options - type: object - responses: - '200': - content: - application/json: - schema: - properties: - choices: - items: - properties: - index: - type: integer - message: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - required: - - message - type: object - type: array - chunks: - items: - properties: - id: - type: string - instance_id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - score: - maximum: 1 - minimum: 0 - type: number - scoring_details: - properties: - fusion_method: - enum: - - rrf - - max - type: string - keyword_rank: - type: number - keyword_score: - minimum: 0 - type: number - reranking_score: - maximum: 1 - minimum: 0 - type: number - vector_rank: - type: number - vector_score: - maximum: 1 - minimum: 0 - type: number - type: object - text: - type: string - type: - type: string - required: - - id - - type - - score - - text - - instance_id - type: object - type: array - errors: - items: - properties: - instance_id: - type: string - message: - type: string - required: - - instance_id - - message - type: object - type: array - id: - type: string - model: - type: string - object: - type: string - required: - - choices - - chunks - type: object - description: Returns the chat completion result with merged chunks from all instances. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Multi-Instance Chat Completions - tags: - - AI Search Account Search - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: chat_completions - /accounts/{account_id}/ai-search/namespaces/{name}/instances: - get: - description: List instances. - operationId: ai-search-namespace-list-instances - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - description: Page number (1-indexed). - in: query - name: page - schema: - default: 1 - description: Page number (1-indexed). - minimum: 1 - type: integer - - description: Number of results per page. - in: query - name: per_page - schema: - default: 20 - description: Number of results per page. - maximum: 100 - minimum: 1 - type: integer - - description: Filter instances whose id contains this string (case-insensitive). - in: query - name: search - schema: - description: Filter instances whose id contains this string (case-insensitive). - type: string - - description: Filter by namespace. - in: query - name: namespace - schema: - description: Filter by namespace. - type: string - - description: Field to order results by. - in: query - name: order_by - schema: - default: created_at - description: Field to order results by. - enum: - - created_at - type: string - - description: Order direction. - in: query - name: order_by_direction - schema: - default: desc - description: Order direction. - enum: - - asc - - desc - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - type: array - result_info: - properties: - count: - type: number - page: - type: number - per_page: - type: number - total_count: - type: number - required: - - page - - per_page - - count - - total_count - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - - result_info - type: object - description: List of instances. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List instances. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: list - post: - description: Create a new instance. - operationId: ai-search-namespace-create-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk: - default: true - type: boolean - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - type: object - responses: - '201': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the new instance. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search instance invalid token. - '403': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Max instances reached. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create new instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: create - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}: - delete: - description: Delete instance. - operationId: ai-search-namespace-delete-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the deleted instance. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Delete instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: delete - get: - description: Read instance. - operationId: ai-search-namespace-fetch-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the instance. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Read instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: read - patch: - description: "Moves an instance from its current namespace to the specified target namespace. Use 'default' as new_namespace to move the instance back to the default namespace. Fails with 400 if the target namespace already has an instance with the same id (ids must be unique within a namespace \u2014 the same id can exist in different namespaces)." - operationId: ai-search-move-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - new_namespace: - description: Target namespace to move the instance into. - type: string - required: - - new_namespace - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Instance moved. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search with this name already exist. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Move an instance to a different namespace. - tags: - - AI Search Namespaces - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Update instance. - operationId: ai-search-namespace-update-instance - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk: - default: true - type: boolean - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - summarization: - default: false - type: boolean - x-auditable: true - summarization_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - system_prompt_ai_search: - nullable: true - type: string - x-auditable: true - system_prompt_index_summarization: - nullable: true - type: string - x-auditable: true - system_prompt_rewrite_query: - nullable: true - type: string - x-auditable: true - token_id: - format: uuid - type: string - x-auditable: true - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - ai_gateway_id: - nullable: true - type: string - x-auditable: true - ai_search_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - cache: - default: true - type: boolean - x-auditable: true - cache_threshold: - default: close_enough - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - x-auditable: true - chunk_overlap: - default: 10 - maximum: 30 - minimum: 0 - type: integer - x-auditable: true - chunk_size: - minimum: 64 - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - custom_metadata: - items: - properties: - data_type: - enum: - - text - - number - - boolean - - datetime - type: string - field_name: - maxLength: 64 - minLength: 1 - type: string - required: - - field_name - - data_type - type: object - maxItems: 5 - type: array - x-auditable: true - embedding_model: - enum: - - '@cf/qwen/qwen3-embedding-0.6b' - - '@cf/baai/bge-m3' - - '@cf/baai/bge-large-en-v1.5' - - '@cf/google/embeddinggemma-300m' - - google-ai-studio/gemini-embedding-001 - - google-ai-studio/gemini-embedding-2-preview - - openai/text-embedding-3-small - - openai/text-embedding-3-large - - '' - - null - nullable: true - type: string - x-auditable: true - enable: - default: true - type: boolean - x-auditable: true - engine_version: - default: 3 - readOnly: true - type: number - fusion_method: - default: rrf - enum: - - max - - rrf - type: string - x-auditable: true - hybrid_search_enabled: - default: false - deprecated: true - description: "Deprecated \u2014 use index_method instead." - type: boolean - x-auditable: true - id: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - index_method: - default: - keyword: false - vector: true - description: Controls which storage backends are used during indexing. Defaults to vector-only. - properties: - keyword: - description: Enable keyword (BM25) storage backend. - type: boolean - vector: - description: Enable vector (embedding) storage backend. - type: boolean - required: - - vector - - keyword - type: object - x-auditable: true - indexing_options: - nullable: true - properties: - keyword_tokenizer: - default: porter - description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. - enum: - - porter - - trigram - type: string - type: object - x-auditable: true - last_activity: - format: date-time - nullable: true - readOnly: true - type: string - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - x-auditable: true - metadata: - properties: - created_from_aisearch_wizard: - type: boolean - search_for_agents: - properties: - hostname: - type: string - zone_id: - type: string - zone_name: - type: string - required: - - zone_id - - zone_name - - hostname - type: object - worker_domain: - type: string - type: object - x-auditable: true - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - namespace: - nullable: true - readOnly: true - type: string - paused: - default: false - type: boolean - x-auditable: true - public_endpoint_id: - nullable: true - readOnly: true - type: string - public_endpoint_params: - properties: - authorized_hosts: - items: - type: string - type: array - chat_completions_endpoint: - properties: - disabled: - default: false - description: Disable chat completions endpoint for this public endpoint - type: boolean - type: object - enabled: - default: false - type: boolean - mcp: - properties: - description: - default: Finds exactly what you're looking for - type: string - disabled: - default: false - description: Disable MCP endpoint for this public endpoint - type: boolean - type: object - rate_limit: - properties: - period_ms: - maximum: 3600000 - minimum: 60000 - type: integer - requests: - minimum: 1 - type: integer - technique: - enum: - - fixed - - sliding - type: string - type: object - search_endpoint: - properties: - disabled: - default: false - description: Disable search endpoint for this public endpoint - type: boolean - type: object - type: object - x-auditable: true - reranking: - default: false - type: boolean - x-auditable: true - reranking_model: - enum: - - '@cf/baai/bge-reranker-base' - - '' - - null - nullable: true - type: string - x-auditable: true - retrieval_options: - nullable: true - properties: - boost_by: - description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - type: object - x-auditable: true - rewrite_model: - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - - '' - - null - nullable: true - type: string - x-auditable: true - rewrite_query: - default: false - type: boolean - x-auditable: true - score_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - x-auditable: true - source: - nullable: true - type: string - x-auditable: true - source_params: - nullable: true - properties: - exclude_items: - description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' - items: - type: string - maxItems: 10 - type: array - include_items: - description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' - items: - type: string - maxItems: 10 - type: array - prefix: - type: string - r2_jurisdiction: - default: default - type: string - web_crawler: - default: - parse_type: sitemap - properties: - crawl_options: - properties: - depth: - maximum: 100000 - minimum: 1 - type: number - include_external_links: - default: false - type: boolean - include_subdomains: - default: false - type: boolean - max_age: - maximum: 604800 - minimum: 0 - type: number - source: - default: all - enum: - - all - - sitemaps - - links - type: string - type: object - parse_options: - properties: - content_selector: - description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. - items: - properties: - path: - description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' - maxLength: 200 - type: string - selector: - description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. - maxLength: 200 - type: string - required: - - path - - selector - type: object - maxItems: 10 - type: array - include_headers: - type: object - include_images: - default: false - type: boolean - specific_sitemaps: - description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. - items: - format: uri - type: string - maxItems: 10 - type: array - use_browser_rendering: - default: false - type: boolean - type: object - parse_type: - default: sitemap - enum: - - sitemap - - feed-rss - - crawl - type: string - store_options: - properties: - r2_jurisdiction: - default: default - type: string - storage_id: - type: string - storage_type: - $ref: '#/components/schemas/r2SippyProvider' - required: - - storage_id - type: object - type: object - type: object - x-auditable: true - status: - default: waiting - readOnly: true - type: string - sync_interval: - default: 21600 - description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' - x-auditable: true - type: number - enum: - - 900 - token_id: - format: uuid - type: string - x-auditable: true - type: - enum: - - r2 - - web-crawler - - null - nullable: true - type: string - x-auditable: true - required: - - id - - created_at - - modified_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the updated instance. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search instance invalid token. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Update instance. - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: update - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions: - post: - description: Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. - operationId: ai-search-namespace-instance-chat-completion - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_search_options: - properties: - cache: - properties: - cache_threshold: - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - enabled: - type: boolean - type: object - query_rewrite: - properties: - enabled: - type: boolean - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - rewrite_prompt: - type: string - type: object - reranking: - properties: - enabled: - type: boolean - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - retrieval: - properties: - boost_by: - description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - context_expansion: - default: 0 - maximum: 3 - minimum: 0 - type: integer - filters: - type: object - fusion_method: - enum: - - max - - rrf - type: string - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - retrieval_type: - enum: - - vector - - keyword - - hybrid - type: string - return_on_failure: - default: true - type: boolean - type: object - type: object - messages: - items: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - minItems: 1 - type: array - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - stream: - type: boolean - required: - - messages - type: object - responses: - '200': - content: - application/json: - schema: - properties: - choices: - items: - properties: - index: - type: integer - message: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - required: - - message - type: object - type: array - chunks: - items: - properties: - id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - score: - maximum: 1 - minimum: 0 - type: number - scoring_details: - properties: - fusion_method: - enum: - - rrf - - max - type: string - keyword_rank: - type: number - keyword_score: - minimum: 0 - type: number - reranking_score: - maximum: 1 - minimum: 0 - type: number - vector_rank: - type: number - vector_score: - maximum: 1 - minimum: 0 - type: number - type: object - text: - type: string - type: - type: string - required: - - id - - type - - score - - text - type: object - type: array - id: - type: string - model: - type: string - object: - type: string - required: - - choices - - chunks - type: object - description: Returns the chat completions results with retrieved files. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Chat Completions - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: chat_completions - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items: - get: - description: Lists indexed items in an AI Search instance. - operationId: ai-search-namespace-instance-list-items - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 50 - minimum: 0 - type: integer - - in: query - name: search - schema: - maxLength: 256 - type: string - - description: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at. - in: query - name: sort_by - schema: - default: status - description: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at. - enum: - - status - - modified_at - type: string - - in: query - name: status - schema: - enum: - - queued - - running - - completed - - error - - skipped - - outdated - type: string - - description: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". - in: query - name: source - schema: - description: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". - maxLength: 512 - type: string - - description: 'JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}' - in: query - name: metadata_filter - schema: - description: 'JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}' - maxLength: 2048 - type: string - - description: Filter items by their unique ID. Returns at most one item. - in: query - name: item_id - schema: - description: Filter items by their unique ID. Returns at most one item. - maxLength: 64 - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - checksum: - readOnly: true - type: string - chunks_count: - nullable: true - readOnly: true - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - error: - readOnly: true - type: string - file_size: - nullable: true - readOnly: true - type: number - x-auditable: true - id: - readOnly: true - type: string - key: - readOnly: true - type: string - last_seen_at: - format: date-time - readOnly: true - type: string - namespace: - readOnly: true - type: string - next_action: - enum: - - INDEX - - DELETE - - null - nullable: true - readOnly: true - type: string - source_id: - description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. - nullable: true - readOnly: true - type: string - status: - enum: - - queued - - running - - completed - - error - - skipped - - outdated - readOnly: true - type: string - required: - - id - - key - - status - - next_action - - checksum - - namespace - - chunks_count - - file_size - - source_id - - last_seen_at - - created_at - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - default: 20 - maximum: 50 - minimum: 5 - type: integer - total_count: - type: integer - required: - - count - - page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns the AI Search items. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Items List. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: list - post: - description: Uploads a file to a managed AI Search instance via multipart/form-data (max 4MB). - operationId: ai-search-namespace-instance-upload-item - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - multipart/form-data: - schema: - properties: - file: - description: The file to upload (max 4MB). Filename must not exceed 128 characters. - format: binary - type: string - metadata: - description: JSON string of custom metadata key-value pairs. - type: string - wait_for_completion: - default: false - description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. - type: boolean - required: - - file - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - checksum: - readOnly: true - type: string - chunks_count: - nullable: true - readOnly: true - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - error: - readOnly: true - type: string - file_size: - nullable: true - readOnly: true - type: number - x-auditable: true - id: - readOnly: true - type: string - key: - readOnly: true - type: string - last_seen_at: - format: date-time - readOnly: true - type: string - namespace: - readOnly: true - type: string - next_action: - enum: - - INDEX - - DELETE - - null - nullable: true - readOnly: true - type: string - source_id: - description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. - nullable: true - readOnly: true - type: string - status: - enum: - - queued - - running - - completed - - error - - skipped - - outdated - readOnly: true - type: string - required: - - id - - key - - status - - next_action - - checksum - - namespace - - chunks_count - - file_size - - source_id - - last_seen_at - - created_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Item uploaded successfully. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Invalid metadata format. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Upload Item. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: upload - put: - description: Creates or updates an indexed item in an AI Search instance. - operationId: ai-search-namespace-instance-create-or-update-item - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - key: - description: Item key / filename. Must not exceed 128 characters. - type: string - next_action: - enum: - - INDEX - type: string - wait_for_completion: - default: false - description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. - type: boolean - required: - - key - - next_action - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - checksum: - readOnly: true - type: string - chunks_count: - nullable: true - readOnly: true - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - error: - readOnly: true - type: string - file_size: - nullable: true - readOnly: true - type: number - x-auditable: true - id: - readOnly: true - type: string - key: - readOnly: true - type: string - last_seen_at: - format: date-time - readOnly: true - type: string - namespace: - readOnly: true - type: string - next_action: - enum: - - INDEX - - DELETE - - null - nullable: true - readOnly: true - type: string - source_id: - description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. - nullable: true - readOnly: true - type: string - status: - enum: - - queued - - running - - completed - - error - - skipped - - outdated - readOnly: true - type: string - required: - - id - - key - - status - - next_action - - checksum - - namespace - - chunks_count - - file_size - - source_id - - last_seen_at - - created_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns a AI Search Item detail. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Filename exceeds maximum length. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to sync item. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create or Update Item. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: create_or_update - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}: - delete: - description: Deletes a file from a managed AI Search instance and triggers a reindex. - operationId: ai-search-namespace-instance-delete-item - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - in: path - name: item_id - schema: - type: string - required: true - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - key: - type: string - required: - - key - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Item deleted successfully. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: This operation requires a managed instance. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Item not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Delete Item. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: delete - get: - description: Retrieves a specific indexed item from an AI Search instance. - operationId: ai-search-namespace-instance-get-item - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - in: path - name: item_id - schema: - type: string - required: true - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - checksum: - readOnly: true - type: string - chunks_count: - nullable: true - readOnly: true - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - error: - readOnly: true - type: string - file_size: - nullable: true - readOnly: true - type: number - x-auditable: true - id: - readOnly: true - type: string - key: - readOnly: true - type: string - last_seen_at: - format: date-time - readOnly: true - type: string - namespace: - readOnly: true - type: string - next_action: - enum: - - INDEX - - DELETE - - null - nullable: true - readOnly: true - type: string - source_id: - description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. - nullable: true - readOnly: true - type: string - status: - enum: - - queued - - running - - completed - - error - - skipped - - outdated - readOnly: true - type: string - required: - - id - - key - - status - - next_action - - checksum - - namespace - - chunks_count - - file_size - - source_id - - last_seen_at - - created_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns a AI Search Item detail. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Get Item. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: get - patch: - description: Syncs an item to an AI Search instance index. - operationId: ai-search-namespace-instance-sync-item - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - in: path - name: item_id - schema: - type: string - required: true - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - next_action: - enum: - - INDEX - type: string - wait_for_completion: - default: false - description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. - type: boolean - required: - - next_action - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - checksum: - readOnly: true - type: string - chunks_count: - nullable: true - readOnly: true - type: integer - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - error: - readOnly: true - type: string - file_size: - nullable: true - readOnly: true - type: number - x-auditable: true - id: - readOnly: true - type: string - key: - readOnly: true - type: string - last_seen_at: - format: date-time - readOnly: true - type: string - namespace: - readOnly: true - type: string - next_action: - enum: - - INDEX - - DELETE - - null - nullable: true - readOnly: true - type: string - source_id: - description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. - nullable: true - readOnly: true - type: string - status: - enum: - - queued - - running - - completed - - error - - skipped - - outdated - readOnly: true - type: string - required: - - id - - key - - status - - next_action - - checksum - - namespace - - chunks_count - - file_size - - source_id - - last_seen_at - - created_at - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns a AI Search Item detail. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to sync item. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Sync Item. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: sync - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks: - get: - description: Lists chunks for a specific item in an AI Search instance, including their text content. - operationId: ai-search-namespace-instance-list-item-chunks - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - in: path - name: item_id - schema: - type: string - required: true - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: limit - schema: - default: 20 - maximum: 100 - minimum: 1 - type: integer - - in: query - name: offset - schema: - default: 0 - minimum: 0 - type: integer - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - end_byte: - type: number - id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - start_byte: - type: number - text: - type: string - required: - - id - - text - - item - type: object - type: array - result_info: - properties: - count: - type: integer - limit: - type: integer - offset: - type: integer - total: - type: integer - required: - - count - - total - - limit - - offset - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns the AI Search item chunks with text content. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Item not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Item Chunks. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: chunks - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download: - get: - description: Downloads the raw file content for a specific item from the managed AI Search instance storage. - operationId: ai-search-namespace-instance-get-item-content - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - in: path - name: item_id - schema: - type: string - required: true - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/octet-stream: - schema: - format: binary - type: string - description: Raw file content. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Content download not available for external source items. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Item not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Download Item Content. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: download - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs: - get: - description: Lists processing logs for a specific item in an AI Search instance. - operationId: ai-search-namespace-instance-logs-item - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - in: path - name: item_id - schema: - type: string - required: true - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: limit - schema: - default: 50 - maximum: 100 - minimum: 1 - type: integer - - in: query - name: cursor - schema: - maxLength: 512 - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - action: - type: string - chunkCount: - nullable: true - type: integer - errorType: - nullable: true - type: string - fileKey: - type: string - message: - nullable: true - type: string - processingTimeMs: - nullable: true - type: integer - timestamp: - format: date-time - type: string - required: - - timestamp - - action - - message - - fileKey - - chunkCount - - processingTimeMs - - errorType - type: object - type: array - result_info: - properties: - count: - type: integer - cursor: - nullable: true - type: string - per_page: - type: integer - truncated: - type: boolean - required: - - count - - per_page - - cursor - - truncated - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns the AI Search item logs. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Item not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Item Logs. - tags: - - AI Search Instances Items - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - items - method: logs - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs: - get: - description: Lists indexing jobs for an AI Search instance. - operationId: ai-search-namespace-instance-list-jobs - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 50 - minimum: 0 - type: integer - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - type: integer - total_count: - type: integer - required: - - count - - page - - per_page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns a list of AI Search Jobs. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Jobs - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - jobs - method: list - post: - description: Creates a new indexing job for an AI Search instance. - operationId: ai-search-namespace-instance-create-job - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - description: - maxLength: 255 - type: string - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the AI Search job id. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '429': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Sync in cooldown. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create new job - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - jobs - method: create - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}: - get: - description: Retrieves details for a specific AI Search indexing job. - operationId: ai-search-namespace-instance-get-job - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns a AI Search Job Details. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Get a Job Details - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - jobs - method: get - patch: - description: Updates the status of an AI Search indexing job. - operationId: ai-search-namespace-instance-change-job-status - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - action: - enum: - - cancel - type: string - required: - - action - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - description: - type: string - end_reason: - type: string - ended_at: - type: string - id: - type: string - x-auditable: true - last_seen_at: - type: string - source: - enum: - - user - - schedule - type: string - x-auditable: true - started_at: - type: string - required: - - id - - source - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the updated AI Search Job. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job cannot be cancelled. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Job not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Change Job Status - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - jobs - method: update - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs: - get: - description: Lists log entries for an AI Search indexing job. - operationId: ai-search-namespace-instance-list-job-logs - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: job_id - in: path - required: true - description: The job ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - in: query - name: page - schema: - default: 1 - minimum: 1 - type: integer - - in: query - name: per_page - schema: - default: 20 - maximum: 500 - minimum: 0 - type: integer - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - created_at: - type: number - readOnly: true - id: - type: integer - message: - type: string - message_type: - type: integer - required: - - id - - message - - message_type - - created_at - type: object - type: array - result_info: - properties: - count: - type: integer - page: - type: integer - per_page: - type: integer - total_count: - type: integer - required: - - count - - page - - per_page - - total_count - type: object - success: - type: boolean - required: - - success - - result - - result_info - type: object - description: Returns a list of AI Search Job Logs. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search not found. - '503': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Unable to connect to ai search. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List Job Logs - tags: - - AI Search Instances Jobs - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - - jobs - method: logs - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search: - post: - description: Executes a semantic search query against an AI Search instance to find relevant indexed content. - operationId: ai-search-namespace-instance-search - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_search_options: - properties: - cache: - properties: - cache_threshold: - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - enabled: - type: boolean - type: object - query_rewrite: - properties: - enabled: - type: boolean - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - rewrite_prompt: - type: string - type: object - reranking: - properties: - enabled: - type: boolean - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - retrieval: - properties: - boost_by: - description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - context_expansion: - default: 0 - maximum: 3 - minimum: 0 - type: integer - filters: - type: object - fusion_method: - enum: - - max - - rrf - type: string - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - retrieval_type: - enum: - - vector - - keyword - - hybrid - type: string - return_on_failure: - default: true - type: boolean - type: object - type: object - messages: - items: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - minItems: 1 - type: array - query: - description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." - minLength: 1 - type: string - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - chunks: - items: - properties: - id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - score: - maximum: 1 - minimum: 0 - type: number - scoring_details: - properties: - fusion_method: - enum: - - rrf - - max - type: string - keyword_rank: - type: number - keyword_score: - minimum: 0 - type: number - reranking_score: - maximum: 1 - minimum: 0 - type: number - vector_rank: - type: number - vector_score: - maximum: 1 - minimum: 0 - type: number - type: object - text: - type: string - type: - type: string - required: - - id - - type - - score - - text - type: object - type: array - search_query: - type: string - required: - - search_query - - chunks - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the search results. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Search - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: search - /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats: - get: - description: Retrieves usage statistics for AI Search instances. - operationId: ai-search-namespace-stats - parameters: - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - completed: - type: integer - engine: - description: Engine-specific metadata. Present only for managed (v3) instances. - properties: - r2: - description: R2 bucket storage usage in bytes. - properties: - metadataSizeBytes: - type: integer - objectCount: - type: integer - payloadSizeBytes: - type: integer - required: - - payloadSizeBytes - - metadataSizeBytes - - objectCount - type: object - vectorize: - description: Vectorize index metadata (dimensions, vector count). - properties: - dimensions: - type: integer - vectorsCount: - type: integer - required: - - vectorsCount - - dimensions - type: object - type: object - error: - type: integer - file_embed_errors: - type: object - index_source_errors: - type: object - last_activity: - format: date-time - type: string - outdated: - type: integer - queued: - type: integer - running: - type: integer - skipped: - type: integer - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the AI Search stats. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Stats - tags: - - AI Search Instances - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - - instances - method: stats - /accounts/{account_id}/ai-search/namespaces/{name}/search: - post: - operationId: ai-search-namespace-multi-instance-search - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: name - in: path - required: true - description: Resource name. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - ai_search_options: - properties: - cache: - properties: - cache_threshold: - enum: - - super_strict_match - - close_enough - - flexible_friend - - anything_goes - type: string - enabled: - type: boolean - type: object - instance_ids: - items: - description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. - maxLength: 64 - minLength: 1 - type: string - x-auditable: true - minItems: 1 - type: array - query_rewrite: - properties: - enabled: - type: boolean - model: - type: string - enum: - - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' - - '@cf/zai-org/glm-4.7-flash' - - '@cf/meta/llama-3.1-8b-instruct-fast' - - '@cf/meta/llama-3.1-8b-instruct-fp8' - - '@cf/meta/llama-4-scout-17b-16e-instruct' - - '@cf/qwen/qwen3-30b-a3b-fp8' - - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' - - '@cf/moonshotai/kimi-k2-instruct' - - '@cf/google/gemma-3-12b-it' - - '@cf/google/gemma-4-26b-a4b-it' - - '@cf/moonshotai/kimi-k2.5' - - anthropic/claude-3-7-sonnet - - anthropic/claude-sonnet-4 - - anthropic/claude-opus-4 - - anthropic/claude-3-5-haiku - - cerebras/qwen-3-235b-a22b-instruct - - cerebras/qwen-3-235b-a22b-thinking - - cerebras/llama-3.3-70b - - cerebras/llama-4-maverick-17b-128e-instruct - - cerebras/llama-4-scout-17b-16e-instruct - - cerebras/gpt-oss-120b - - google-ai-studio/gemini-2.5-flash - - google-ai-studio/gemini-2.5-pro - - grok/grok-4 - - groq/llama-3.3-70b-versatile - - groq/llama-3.1-8b-instant - - openai/gpt-5 - - openai/gpt-5-mini - - openai/gpt-5-nano - rewrite_prompt: - type: string - type: object - reranking: - properties: - enabled: - type: boolean - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - model: - type: string - enum: - - '@cf/baai/bge-reranker-base' - type: object - retrieval: - properties: - boost_by: - description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. - items: - properties: - direction: - description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." - enum: - - asc - - desc - - exists - - not_exists - type: string - field: - description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. - maxLength: 64 - minLength: 1 - type: string - required: - - field - type: object - maxItems: 3 - type: array - context_expansion: - default: 0 - maximum: 3 - minimum: 0 - type: integer - filters: - type: object - fusion_method: - enum: - - max - - rrf - type: string - keyword_match_mode: - default: and - description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. - enum: - - and - - or - type: string - match_threshold: - default: 0.4 - maximum: 1 - minimum: 0 - type: number - max_num_results: - default: 10 - maximum: 50 - minimum: 1 - type: integer - retrieval_type: - enum: - - vector - - keyword - - hybrid - type: string - return_on_failure: - default: true - type: boolean - type: object - required: - - instance_ids - type: object - messages: - items: - properties: - content: - nullable: true - type: string - role: - enum: - - system - - developer - - user - - assistant - - tool - type: string - required: - - role - - content - type: object - minItems: 1 - type: array - query: - description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." - minLength: 1 - type: string - required: - - ai_search_options - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - chunks: - items: - properties: - id: - type: string - instance_id: - type: string - item: - properties: - key: - type: string - metadata: - type: object - timestamp: - type: number - required: - - key - type: object - score: - maximum: 1 - minimum: 0 - type: number - scoring_details: - properties: - fusion_method: - enum: - - rrf - - max - type: string - keyword_rank: - type: number - keyword_score: - minimum: 0 - type: number - reranking_score: - maximum: 1 - minimum: 0 - type: number - vector_rank: - type: number - vector_score: - maximum: 1 - minimum: 0 - type: number - type: object - text: - type: string - type: - type: string - required: - - id - - type - - score - - text - - instance_id - type: object - type: array - errors: - items: - properties: - instance_id: - type: string - message: - type: string - required: - - instance_id - - message - type: object - type: array - search_query: - type: string - required: - - search_query - - chunks - type: object - success: - type: boolean - required: - - success - - result - type: object - description: Returns the merged search results from all instances. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Not Found - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Multi-Instance Search - tags: - - AI Search Account Search - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - namespaces - method: search - /accounts/{account_id}/ai-search/tokens: - get: - description: List tokens. - operationId: ai-search-list-tokens - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - description: Page number (1-indexed). - in: query - name: page - schema: - default: 1 - description: Page number (1-indexed). - maximum: 100 - minimum: 1 - type: integer - - description: Number of results per page. - in: query - name: per_page - schema: - default: 20 - description: Number of results per page. - maximum: 100 - minimum: 1 - type: integer - - description: Filter tokens whose name contains this string (case-insensitive). - in: query - name: search - schema: - description: Filter tokens whose name contains this string (case-insensitive). - maxLength: 256 - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - cf_api_id: - type: string - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - enabled: - default: true - type: boolean - x-auditable: true - id: - format: uuid - type: string - x-auditable: true - legacy: - default: true - readOnly: true - type: boolean - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - name: - type: string - x-auditable: true - required: - - id - - name - - cf_api_id - - created_at - - modified_at - type: object - type: array - result_info: - properties: - count: - type: number - page: - type: number - per_page: - type: number - total_count: - type: number - required: - - page - - per_page - - count - - total_count - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - - result_info - type: object - description: List of tokens. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: List tokens. - tags: - - AI Search Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - tokens - method: list - post: - description: Create a new token. - operationId: ai-search-create-tokens - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - cf_api_id: - type: string - cf_api_key: - type: string - writeOnly: true - x-sensitive: true - legacy: - default: true - type: boolean - name: - type: string - required: - - name - - cf_api_id - - cf_api_key - type: object - responses: - '201': - content: - application/json: - schema: - properties: - result: - properties: - cf_api_id: - type: string - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - enabled: - default: true - type: boolean - x-auditable: true - id: - format: uuid - type: string - x-auditable: true - legacy: - default: true - readOnly: true - type: boolean - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - name: - type: string - x-auditable: true - required: - - id - - name - - cf_api_id - - created_at - - modified_at - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Token created. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search instance invalid token. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Create token. - tags: - - AI Search Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - tokens - method: create - /accounts/{account_id}/ai-search/tokens/{id}: - delete: - description: Delete token. - operationId: ai-search-delete-tokens - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Token deleted. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Token not found. - '409': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Token in use by instances. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Delete token. - tags: - - AI Search Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - tokens - method: delete - get: - description: Read token. - operationId: ai-search-fetch-tokens - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - cf_api_id: - type: string - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - enabled: - default: true - type: boolean - x-auditable: true - id: - format: uuid - type: string - x-auditable: true - legacy: - default: true - readOnly: true - type: boolean - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - name: - type: string - x-auditable: true - required: - - id - - name - - cf_api_id - - created_at - - modified_at - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Token details. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - path: - items: - type: string - type: array - required: - - code - - message - - path - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Input Validation Error - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Token not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Read token. - tags: - - AI Search Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - tokens - method: read - put: - description: Update token. - operationId: ai-search-update-tokens - parameters: - - name: account_id - in: path - required: true - description: The Cloudflare account ID. - schema: - type: string - - name: id - in: path - required: true - description: Resource ID. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - cf_api_id: - type: string - cf_api_key: - type: string - writeOnly: true - x-sensitive: true - legacy: - default: true - type: boolean - name: - type: string - required: - - name - - cf_api_id - - cf_api_key - type: object - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - cf_api_id: - type: string - x-auditable: true - created_at: - format: date-time - readOnly: true - type: string - created_by: - nullable: true - readOnly: true - type: string - enabled: - default: true - type: boolean - x-auditable: true - id: - format: uuid - type: string - x-auditable: true - legacy: - default: true - readOnly: true - type: boolean - modified_at: - format: date-time - readOnly: true - type: string - modified_by: - nullable: true - readOnly: true - type: string - name: - type: string - x-auditable: true - required: - - id - - name - - cf_api_id - - created_at - - modified_at - type: object - success: - enum: - - true - type: boolean - required: - - success - - result - type: object - description: Returns the updated token. - '400': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Ai search instance invalid token. - '404': - content: - application/json: - schema: - properties: - errors: - items: - properties: - code: - type: number - message: - type: string - required: - - code - - message - type: object - type: array - success: - enum: - - false - type: boolean - required: - - success - - errors - type: object - description: Token not found. - security: - - api_token: [] - - api_email: [] - api_key: [] - summary: Update token. - tags: - - AI Search Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.ai-search - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - x-stackql-sdk: - service: aisearch - resource_chain: - - tokens - method: update -components: - schemas: - r2SippyProvider: - enum: - - r2 - type: string - x-auditable: true - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. - api_key: - in: header - name: X-Auth-Key - type: apiKey - description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. - api_token: - scheme: bearer - type: http - description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). +openapi: 3.0.3 +info: + title: ai_search API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- description: Client API + url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/ai-search/instances: + get: + description: List instances. + operationId: ai-search-list-instances + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter instances whose id contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter instances whose id contains this string (case-insensitive). + type: string + - description: Filter by namespace. + in: query + name: namespace + schema: + description: Filter by namespace. + type: string + - description: Field to order results by. + in: query + name: order_by + schema: + default: created_at + description: Field to order results by. + enum: + - created_at + type: string + - description: Order direction. + in: query + name: order_by_direction + schema: + default: desc + description: Order direction. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List instances. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: list + post: + description: Create a new instance. + operationId: ai-search-create-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the new instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Max instances reached. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: create + /accounts/{account_id}/ai-search/instances/{id}: + delete: + description: Delete instance. + operationId: ai-search-delete-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the deleted instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: delete + get: + description: Read instance. + operationId: ai-search-fetch-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: read + put: + description: Update instance. + operationId: ai-search-update-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + summarization: + default: false + type: boolean + x-auditable: true + summarization_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + system_prompt_ai_search: + nullable: true + type: string + x-auditable: true + system_prompt_index_summarization: + nullable: true + type: string + x-auditable: true + system_prompt_rewrite_query: + nullable: true + type: string + x-auditable: true + token_id: + format: uuid + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: update + /accounts/{account_id}/ai-search/instances/{id}/chat/completions: + post: + description: Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. + operationId: ai-search-instance-chat-completion + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + stream: + type: boolean + required: + - messages + type: object + responses: + '200': + content: + application/json: + schema: + properties: + choices: + items: + properties: + index: + type: integer + message: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + required: + - message + type: object + type: array + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + id: + type: string + model: + type: string + object: + type: string + required: + - choices + - chunks + type: object + description: Returns the chat completions results with retrieved files. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Chat Completions + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: chat_completions + /accounts/{account_id}/ai-search/instances/{id}/jobs: + get: + description: Lists indexing jobs for an AI Search instance. + operationId: ai-search-instance-list-jobs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Jobs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Jobs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + - jobs + method: list + post: + description: Creates a new indexing job for an AI Search instance. + operationId: ai-search-instance-create-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + maxLength: 255 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search job id. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Sync in cooldown. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new job + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + - jobs + method: create + /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}: + get: + description: Retrieves details for a specific AI Search indexing job. + operationId: ai-search-instance-get-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Job Details. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Job Details + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + - jobs + method: get + patch: + description: Updates the status of an AI Search indexing job. + operationId: ai-search-instance-change-job-status + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + enum: + - cancel + type: string + required: + - action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated AI Search Job. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job cannot be cancelled. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change Job Status + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs: + get: + description: Lists log entries for an AI Search indexing job. + operationId: ai-search-instance-list-job-logs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 500 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + type: number + readOnly: true + id: + type: integer + message: + type: string + message_type: + type: integer + required: + - id + - message + - message_type + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Job Logs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Job Logs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + - jobs + method: logs + /accounts/{account_id}/ai-search/instances/{id}/search: + post: + description: Executes a semantic search query against an AI Search instance to find relevant indexed content. + operationId: ai-search-instance-search + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + query: + description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." + minLength: 1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + search_query: + type: string + required: + - search_query + - chunks + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the search results. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: search + /accounts/{account_id}/ai-search/instances/{id}/stats: + get: + description: Retrieves usage statistics for AI Search instances. + operationId: ai-search-stats + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + completed: + type: integer + engine: + description: Engine-specific metadata. Present only for managed (v3) instances. + properties: + r2: + description: R2 bucket storage usage in bytes. + properties: + metadataSizeBytes: + type: integer + objectCount: + type: integer + payloadSizeBytes: + type: integer + required: + - payloadSizeBytes + - metadataSizeBytes + - objectCount + type: object + vectorize: + description: Vectorize index metadata (dimensions, vector count). + properties: + dimensions: + type: integer + vectorsCount: + type: integer + required: + - vectorsCount + - dimensions + type: object + type: object + error: + type: integer + file_embed_errors: + type: object + index_source_errors: + type: object + last_activity: + format: date-time + type: string + outdated: + type: integer + queued: + type: integer + running: + type: integer + skipped: + type: integer + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search stats. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Stats + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - instances + method: stats + /accounts/{account_id}/ai-search/namespaces: + get: + description: List namespaces. + operationId: ai-search-list-namespaces + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter namespaces whose name or description contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter namespaces whose name or description contains this string (case-insensitive). + maxLength: 256 + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of namespaces. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List namespaces. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: list + post: + description: Create a new namespace. + operationId: ai-search-create-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Namespace created. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Max namespaces reached. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace already exists. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: create + /accounts/{account_id}/ai-search/namespaces/{name}: + delete: + description: Delete namespace. + operationId: ai-search-delete-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Namespace deleted. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not empty. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: delete + get: + description: Read namespace. + operationId: ai-search-fetch-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Namespace details. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: read + put: + description: Update namespace. + operationId: ai-search-update-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Returns the updated namespace. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Cannot modify default namespace. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: update + /accounts/{account_id}/ai-search/namespaces/{name}/chat/completions: + post: + description: Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response. + operationId: ai-search-namespace-multi-instance-chat-completion + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + instance_ids: + items: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + minItems: 1 + type: array + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + required: + - instance_ids + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + stream: + type: boolean + required: + - messages + - ai_search_options + type: object + responses: + '200': + content: + application/json: + schema: + properties: + choices: + items: + properties: + index: + type: integer + message: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + required: + - message + type: object + type: array + chunks: + items: + properties: + id: + type: string + instance_id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + - instance_id + type: object + type: array + errors: + items: + properties: + instance_id: + type: string + message: + type: string + required: + - instance_id + - message + type: object + type: array + id: + type: string + model: + type: string + object: + type: string + required: + - choices + - chunks + type: object + description: Returns the chat completion result with merged chunks from all instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Multi-Instance Chat Completions + tags: + - AI Search Account Search + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: chat_completions + /accounts/{account_id}/ai-search/namespaces/{name}/instances: + get: + description: List instances. + operationId: ai-search-namespace-list-instances + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter instances whose id contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter instances whose id contains this string (case-insensitive). + type: string + - description: Filter by namespace. + in: query + name: namespace + schema: + description: Filter by namespace. + type: string + - description: Field to order results by. + in: query + name: order_by + schema: + default: created_at + description: Field to order results by. + enum: + - created_at + type: string + - description: Order direction. + in: query + name: order_by_direction + schema: + default: desc + description: Order direction. + enum: + - asc + - desc + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List instances. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: list + post: + description: Create a new instance. + operationId: ai-search-namespace-create-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the new instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Max instances reached. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: create + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}: + delete: + description: Delete instance. + operationId: ai-search-namespace-delete-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the deleted instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: delete + get: + description: Read instance. + operationId: ai-search-namespace-fetch-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: read + patch: + description: "Moves an instance from its current namespace to the specified target namespace. Use 'default' as new_namespace to move the instance back to the default namespace. Fails with 400 if the target namespace already has an instance with the same id (ids must be unique within a namespace \u2014 the same id can exist in different namespaces)." + operationId: ai-search-move-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + new_namespace: + description: Target namespace to move the instance into. + type: string + required: + - new_namespace + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Instance moved. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search with this name already exist. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Move an instance to a different namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + description: Update instance. + operationId: ai-search-namespace-update-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + summarization: + default: false + type: boolean + x-auditable: true + summarization_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + system_prompt_ai_search: + nullable: true + type: string + x-auditable: true + system_prompt_index_summarization: + nullable: true + type: string + x-auditable: true + system_prompt_rewrite_query: + nullable: true + type: string + x-auditable: true + token_id: + format: uuid + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: update + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions: + post: + description: Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. + operationId: ai-search-namespace-instance-chat-completion + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + stream: + type: boolean + required: + - messages + type: object + responses: + '200': + content: + application/json: + schema: + properties: + choices: + items: + properties: + index: + type: integer + message: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + required: + - message + type: object + type: array + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + id: + type: string + model: + type: string + object: + type: string + required: + - choices + - chunks + type: object + description: Returns the chat completions results with retrieved files. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Chat Completions + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: chat_completions + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items: + get: + description: Lists indexed items in an AI Search instance. + operationId: ai-search-namespace-instance-list-items + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + - in: query + name: search + schema: + maxLength: 256 + type: string + - description: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at. + in: query + name: sort_by + schema: + default: status + description: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at. + enum: + - status + - modified_at + type: string + - in: query + name: status + schema: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + type: string + - description: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". + in: query + name: source + schema: + description: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". + maxLength: 512 + type: string + - description: 'JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}' + in: query + name: metadata_filter + schema: + description: 'JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}' + maxLength: 2048 + type: string + - description: Filter items by their unique ID. Returns at most one item. + in: query + name: item_id + schema: + description: Filter items by their unique ID. Returns at most one item. + maxLength: 64 + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + default: 20 + maximum: 50 + minimum: 5 + type: integer + total_count: + type: integer + required: + - count + - page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search items. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Items List. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: list + post: + description: Uploads a file to a managed AI Search instance via multipart/form-data (max 4MB). + operationId: ai-search-namespace-instance-upload-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: The file to upload (max 4MB). Filename must not exceed 128 characters. + format: binary + type: string + metadata: + description: JSON string of custom metadata key-value pairs. + type: string + wait_for_completion: + default: false + description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. + type: boolean + required: + - file + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Item uploaded successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Invalid metadata format. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: upload + put: + description: Creates or updates an indexed item in an AI Search instance. + operationId: ai-search-namespace-instance-create-or-update-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + key: + description: Item key / filename. Must not exceed 128 characters. + type: string + next_action: + enum: + - INDEX + type: string + wait_for_completion: + default: false + description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. + type: boolean + required: + - key + - next_action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Item detail. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Filename exceeds maximum length. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to sync item. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create or Update Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: create_or_update + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}: + delete: + description: Deletes a file from a managed AI Search instance and triggers a reindex. + operationId: ai-search-namespace-instance-delete-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + key: + type: string + required: + - key + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Item deleted successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: This operation requires a managed instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: delete + get: + description: Retrieves a specific indexed item from an AI Search instance. + operationId: ai-search-namespace-instance-get-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Item detail. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: get + patch: + description: Syncs an item to an AI Search instance index. + operationId: ai-search-namespace-instance-sync-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + next_action: + enum: + - INDEX + type: string + wait_for_completion: + default: false + description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. + type: boolean + required: + - next_action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Item detail. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to sync item. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Sync Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: sync + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks: + get: + description: Lists chunks for a specific item in an AI Search instance, including their text content. + operationId: ai-search-namespace-instance-list-item-chunks + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: offset + schema: + default: 0 + minimum: 0 + type: integer + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + end_byte: + type: number + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + start_byte: + type: number + text: + type: string + required: + - id + - text + - item + type: object + type: array + result_info: + properties: + count: + type: integer + limit: + type: integer + offset: + type: integer + total: + type: integer + required: + - count + - total + - limit + - offset + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search item chunks with text content. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Item Chunks. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: chunks + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download: + get: + description: Downloads the raw file content for a specific item from the managed AI Search instance storage. + operationId: ai-search-namespace-instance-get-item-content + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + format: binary + type: string + description: Raw file content. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Content download not available for external source items. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Download Item Content. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: download + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs: + get: + description: Lists processing logs for a specific item in an AI Search instance. + operationId: ai-search-namespace-instance-logs-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + default: 50 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: cursor + schema: + maxLength: 512 + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + action: + type: string + chunkCount: + nullable: true + type: integer + errorType: + nullable: true + type: string + fileKey: + type: string + message: + nullable: true + type: string + processingTimeMs: + nullable: true + type: integer + timestamp: + format: date-time + type: string + required: + - timestamp + - action + - message + - fileKey + - chunkCount + - processingTimeMs + - errorType + type: object + type: array + result_info: + properties: + count: + type: integer + cursor: + nullable: true + type: string + per_page: + type: integer + truncated: + type: boolean + required: + - count + - per_page + - cursor + - truncated + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search item logs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Item Logs. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - items + method: logs + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs: + get: + description: Lists indexing jobs for an AI Search instance. + operationId: ai-search-namespace-instance-list-jobs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Jobs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Jobs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - jobs + method: list + post: + description: Creates a new indexing job for an AI Search instance. + operationId: ai-search-namespace-instance-create-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + maxLength: 255 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search job id. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Sync in cooldown. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new job + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - jobs + method: create + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}: + get: + description: Retrieves details for a specific AI Search indexing job. + operationId: ai-search-namespace-instance-get-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Job Details. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Job Details + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - jobs + method: get + patch: + description: Updates the status of an AI Search indexing job. + operationId: ai-search-namespace-instance-change-job-status + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + enum: + - cancel + type: string + required: + - action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated AI Search Job. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job cannot be cancelled. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change Job Status + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - jobs + method: update + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs: + get: + description: Lists log entries for an AI Search indexing job. + operationId: ai-search-namespace-instance-list-job-logs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 500 + minimum: 0 + type: integer + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + type: number + readOnly: true + id: + type: integer + message: + type: string + message_type: + type: integer + required: + - id + - message + - message_type + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Job Logs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Job Logs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + - jobs + method: logs + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search: + post: + description: Executes a semantic search query against an AI Search instance to find relevant indexed content. + operationId: ai-search-namespace-instance-search + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + query: + description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." + minLength: 1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + search_query: + type: string + required: + - search_query + - chunks + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the search results. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: search + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats: + get: + description: Retrieves usage statistics for AI Search instances. + operationId: ai-search-namespace-stats + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + completed: + type: integer + engine: + description: Engine-specific metadata. Present only for managed (v3) instances. + properties: + r2: + description: R2 bucket storage usage in bytes. + properties: + metadataSizeBytes: + type: integer + objectCount: + type: integer + payloadSizeBytes: + type: integer + required: + - payloadSizeBytes + - metadataSizeBytes + - objectCount + type: object + vectorize: + description: Vectorize index metadata (dimensions, vector count). + properties: + dimensions: + type: integer + vectorsCount: + type: integer + required: + - vectorsCount + - dimensions + type: object + type: object + error: + type: integer + file_embed_errors: + type: object + index_source_errors: + type: object + last_activity: + format: date-time + type: string + outdated: + type: integer + queued: + type: integer + running: + type: integer + skipped: + type: integer + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search stats. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Stats + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + - instances + method: stats + /accounts/{account_id}/ai-search/namespaces/{name}/search: + post: + operationId: ai-search-namespace-multi-instance-search + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + instance_ids: + items: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + minItems: 1 + type: array + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + required: + - instance_ids + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + query: + description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." + minLength: 1 + type: string + required: + - ai_search_options + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + chunks: + items: + properties: + id: + type: string + instance_id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + - instance_id + type: object + type: array + errors: + items: + properties: + instance_id: + type: string + message: + type: string + required: + - instance_id + - message + type: object + type: array + search_query: + type: string + required: + - search_query + - chunks + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the merged search results from all instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Multi-Instance Search + tags: + - AI Search Account Search + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - namespaces + method: search + /accounts/{account_id}/ai-search/tokens: + get: + description: List tokens. + operationId: ai-search-list-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + maximum: 100 + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter tokens whose name contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter tokens whose name contains this string (case-insensitive). + maxLength: 256 + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of tokens. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List tokens. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - tokens + method: list + post: + description: Create a new token. + operationId: ai-search-create-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cf_api_id: + type: string + cf_api_key: + type: string + writeOnly: true + x-sensitive: true + legacy: + default: true + type: boolean + name: + type: string + required: + - name + - cf_api_id + - cf_api_key + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Token created. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - tokens + method: create + /accounts/{account_id}/ai-search/tokens/{id}: + delete: + description: Delete token. + operationId: ai-search-delete-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Token deleted. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token not found. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token in use by instances. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - tokens + method: delete + get: + description: Read token. + operationId: ai-search-fetch-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Token details. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - tokens + method: read + put: + description: Update token. + operationId: ai-search-update-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cf_api_id: + type: string + cf_api_key: + type: string + writeOnly: true + x-sensitive: true + legacy: + default: true + type: boolean + name: + type: string + required: + - name + - cf_api_id + - cf_api_key + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Returns the updated token. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_search + resource_chain: + - tokens + method: update +components: + schemas: + r2SippyProvider: + enum: + - r2 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). diff --git a/stackql_cloudflare/stackql_cloudflare_provider/ai_docs_enhance.py b/stackql_cloudflare/stackql_cloudflare_provider/ai_docs_enhance.py new file mode 100644 index 00000000000..76931a5a0b6 --- /dev/null +++ b/stackql_cloudflare/stackql_cloudflare_provider/ai_docs_enhance.py @@ -0,0 +1,194 @@ +"""Enhance the Workers AI task-family doc pages (and the generic run +page). + +Docgen renders the family resources mechanically, which leaves two gaps: + +1. The SELECT example only shows the REQUIRED params (`account_id`, + `model_name`) in the WHERE clause - the model input properties + (prompt, text, audio, ...) come from the `request.schema_override` + union schema which docgen does not surface. Without them the example + is not a runnable query. +2. Nothing tells the reader which models are valid for `model_name`. + +This pass, driven by `provider-dev/config/ai_task_families.yaml`, +rewrites each family page (`website/docs/services/ai//index.md`) +plus the generic `run` page: + +- Inserts a `:::info[Supported models]` admonition after the Overview + table listing every member model as a `` entry (the + run page lists all families' members plus the octet-input exec-only + models). +- Rewrites the SELECT example: the column list becomes the family's + typed result fields (or `contents`), and the WHERE clause gains the + family's primary input properties as commented optional params. + +Runs after `octet_stream_docs.py` in the generate-docs chain. +Idempotent: the admonition is replaced between markers and the sql block +is rebuilt deterministically. +""" +from __future__ import annotations + +import argparse +import logging +import re +import sys +from pathlib import Path +from typing import Dict, List, Optional + +import yaml + + +logger = logging.getLogger(__name__) + +PKG_DIR = Path(__file__).resolve().parent +CONFIG_PATH = PKG_DIR.parent / "provider-dev" / "config" / "ai_task_families.yaml" +DOCS_AI_DIR = PKG_DIR.parent / "website" / "docs" / "services" / "ai" + +# Primary input properties shown as WHERE params in each family's SELECT +# example. These are illustrative (the full union of inputs is in the +# request schema); pick the ones a first query actually needs. +EXAMPLE_INPUTS: Dict[str, List[str]] = { + "text_generation": ["prompt"], + "text_embeddings": ["text"], + "text_to_image": ["prompt"], + "text_to_speech": ["text"], + "speech_to_text": ["audio"], + "translation": ["text", "target_lang"], + "summarization": ["input_text"], + "text_classification": ["text"], + "reranking": ["query", "contexts"], + "run": ["prompt"], +} + +ADMONITION_START = ":::info[Supported models]" + + +def _admonition(models_by_group: "Dict[str, List[str]]", note: str = "") -> str: + """Each group renders as a collapsible
block so long model + lists don't overwhelm the page.""" + lines = [ADMONITION_START, "", "Set `model_name` to one of the following models:", ""] + for group, models in models_by_group.items(): + lines.append("
") + lines.append(f"{group} ({len(models)} model{'s' if len(models) != 1 else ''})") + lines.append("") + for m in models: + lines.append(f'
') + lines.append("") + lines.append("
") + lines.append("") + if note: + lines.append(note) + lines.append("") + lines.append(":::") + return "\n".join(lines) + + +def _select_sql(resource: str, columns: List[str], inputs: List[str]) -> str: + lines = ["```sql", "SELECT"] + lines.append(",\n".join(columns)) + lines.append(f"FROM cloudflare.ai.{resource}") + lines.append("WHERE account_id = '{{ account_id }}' -- required") + lines.append("AND model_name = '{{ model_name }}' -- required") + for i in inputs: + lines.append("AND " + i + " = '{{ " + i + " }}' -- model input") + lines.append(";") + lines.append("```") + return "\n".join(lines) + + +def _patch_page(page: Path, resource: str, models_by_group: "Dict[str, List[str]]", + columns: List[str], note: str = "") -> bool: + text = page.read_text(encoding="utf-8") + orig = text + + # 1. Supported-models admonition: replace existing block or insert + # after the Overview table (before "## Fields"). + admon = _admonition(models_by_group, note) + if ADMONITION_START in text: + text = re.sub( + re.escape(ADMONITION_START) + r".*?\n:::\n", admon + "\n", + text, count=1, flags=re.DOTALL) + else: + anchor = "\n## Fields" + if anchor not in text: + logger.warning("%s: no '## Fields' anchor - skipping admonition", page) + else: + #
gives the admonition breathing room below the + # Overview table (docusaurus renders them flush otherwise) + text = text.replace(anchor, "\n
\n\n" + admon + "\n" + anchor, 1) + + # 2. SELECT example rewrite (first sql block in the SELECT examples section). + sec_m = re.search(r"## `SELECT` examples.*?(?=\n## |\Z)", text, re.DOTALL) + if sec_m: + section = sec_m.group(0) + sql_m = re.search(r"```sql\n.*?```", section, re.DOTALL) + if sql_m: + new_section = section.replace( + sql_m.group(0), _select_sql(resource, columns, EXAMPLE_INPUTS.get(resource, [])), 1) + text = text.replace(section, new_section, 1) + else: + logger.warning("%s: no SELECT examples section", page) + + if text != orig: + page.write_text(text, encoding="utf-8", newline="\n") + return True + return False + + +def main(argv: Optional[List[str]] = None) -> int: + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--config", default=str(CONFIG_PATH)) + parser.add_argument("--docs-ai-dir", default=str(DOCS_AI_DIR)) + parser.add_argument("-v", "--verbose", action="store_true") + args = parser.parse_args(argv) + + logging.basicConfig( + level=logging.DEBUG if args.verbose else logging.INFO, + format="%(asctime)s %(levelname)s %(message)s", + ) + + config = yaml.safe_load(Path(args.config).read_text(encoding="utf-8")) + families: Dict[str, dict] = config.get("families") or {} + octet_models: List[str] = config.get("excluded_octet_input_models") or [] + docs_dir = Path(args.docs_ai_dir) + if not docs_dir.exists(): + logger.error("ai docs dir not found: %s. Run `npm run generate-docs` first.", docs_dir) + return 1 + + patched = 0 + for fam, meta in families.items(): + page = docs_dir / fam / "index.md" + if not page.exists(): + logger.warning("page missing: %s", page) + continue + mode = meta.get("mode") or "object" + columns = list((meta.get("result_fields") or {}).keys()) if mode == "object" else ["contents"] + if _patch_page(page, fam, {meta.get("title") or fam: sorted(meta.get("members") or [])}, columns): + patched += 1 + logger.info("patched %s", fam) + + # Generic run page: all families' members grouped, plus a note about + # the octet-input exec methods. + run_page = docs_dir / "run" / "index.md" + if run_page.exists(): + groups = {(meta.get("title") or fam): sorted(meta.get("members") or []) + for fam, meta in families.items()} + note = ("The task-family resources above give these models typed result columns - " + "prefer them over `run` where one exists. Binary-input models (" + + ", ".join(f"`{m}`" for m in sorted(octet_models)) + + ") take a raw request body and are exposed as exec methods on this resource " + "instead of SELECT.") + if _patch_page(run_page, "run", groups, + ["response", "usage", "data", "shape", "text", "translated_text", "summary"], + note): + patched += 1 + logger.info("patched run") + else: + logger.warning("run page missing: %s", run_page) + + logger.info("Patched %d ai doc pages.", patched) + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/stackql_cloudflare/stackql_cloudflare_provider/ai_task_families.py b/stackql_cloudflare/stackql_cloudflare_provider/ai_task_families.py new file mode 100644 index 00000000000..e9673f69657 --- /dev/null +++ b/stackql_cloudflare/stackql_cloudflare_provider/ai_task_families.py @@ -0,0 +1,376 @@ +"""Collapse the per-model Workers AI run resources into task-family +resources. + +The upstream spec exposes ~98 per-model operations +(`POST /accounts/{account_id}/ai/run/@cf//`) which the +generator turns into ~99 single-method resources - overwhelming the `ai` +service and all non-selectable. It also exposes a generic +`POST /accounts/{account_id}/ai/run/{model_name}` operation which works +with slash-containing model names (verified live through stackql - the +value substitutes literally into the URL). + +This pass, driven by `provider-dev/config/ai_task_families.yaml`: + +1. Rewrites the generic run operation's 200 response to a typed union + envelope (`stackqlAiRunResponseEnvelope`): `result` carries the union + of all object-mode families' result fields, plus a top-level + `contents` column used by the contents-mode families. +2. Creates one resource per task family (`cloudflare.ai.text_generation`, + `cloudflare.ai.text_embeddings`, ...) with a single `run` SELECT + method riding the generic operation: + - `request.schema_override` -> `stackqlAiRunInput`, the union + of the member models' request-body properties. WHERE params bind to + these with unprefixed names (SELECT semantics - `data__` does not + apply to SELECT). + - a `request.transform` that serialises exactly the SET/WHERE-provided + properties (same dual-mode complex/scalar pattern as + `request_body_transforms.py`). + - object-mode families project `objectKey: $.result` (typed columns); + contents-mode families wrap the raw response as a `contents` column + (binary or non-object results). +3. Points the generic `ai.run` resource's `run` method at the same + machinery and adds a select mapping - it remains the escape hatch for + models not yet listed in any family. +4. Deletes the member models' per-model paths and resources from the + generated ai.yaml. Component schemas are left in place (still + referenced by the synthesised input schemas). + +Models whose only input is a raw octet-stream body (whisper, resnet, +detr) are excluded: binary WHERE values are impractical, so they keep +their per-model insert resources (handled by `octet_stream_requests.py`). + +Runs after `octet_stream_requests.py` in the generate-provider chain. +Idempotent: if the member paths are already gone (pass previously +applied), families are left as they are. +""" +from __future__ import annotations + +import argparse +import copy +import logging +import sys +from pathlib import Path +from typing import Any, Dict, List, Optional, Tuple + +import yaml + + +logger = logging.getLogger(__name__) + + +_YAML_1_1_BOOL_LITERALS = frozenset({ + "y", "Y", "yes", "Yes", "YES", + "n", "N", "no", "No", "NO", + "true", "True", "TRUE", + "false", "False", "FALSE", + "on", "On", "ON", + "off", "Off", "OFF", +}) + + +def _represent_str_yaml11_safe(dumper, data): + style = "'" if data in _YAML_1_1_BOOL_LITERALS else None + return dumper.represent_scalar("tag:yaml.org,2002:str", data, style=style) + + +yaml.SafeDumper.add_representer(str, _represent_str_yaml11_safe) + + +PKG_DIR = Path(__file__).resolve().parent +PROVIDER_DIR = ( + PKG_DIR.parent + / "provider-dev" / "openapi" / "src" / "cloudflare" / "v00.00.00000" +) +CONFIG_PATH = PKG_DIR.parent / "provider-dev" / "config" / "ai_task_families.yaml" + +GENERIC_PATH = "/accounts/{account_id}/ai/run/{model_name}" +GENERIC_OP_REF = "#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post" +ENVELOPE_SCHEMA = "stackqlAiRunResponseEnvelope" +_SCHEMA_REF_PREFIX = "#/components/schemas/" +_COMPLEX_TYPES = ("array", "object") + + +def _pascal(s: str) -> str: + return "".join(p[:1].upper() + p[1:] for p in s.replace("-", "_").split("_") if p) + + +def _model_path(model: str) -> str: + return "/accounts/{account_id}/ai/run/" + model + + +def _resolve_ref(ref: str, schemas: Dict[str, Any]) -> Optional[dict]: + if not ref.startswith(_SCHEMA_REF_PREFIX): + return None + return schemas.get(ref[len(_SCHEMA_REF_PREFIX):]) + + +def _prop_kind(prop: Any, schemas: Dict[str, Any]) -> str: + """'complex' | 'scalar' | 'unknown' - one or two $ref hops allowed.""" + seen = 0 + while isinstance(prop, dict) and "$ref" in prop and seen < 3: + prop = _resolve_ref(prop["$ref"], schemas) or {} + seen += 1 + if not isinstance(prop, dict): + return "unknown" + t = prop.get("type") + if t in _COMPLEX_TYPES: + return "complex" + if t in ("string", "number", "integer", "boolean"): + return "scalar" + if isinstance(prop.get("properties"), dict): + return "complex" + if isinstance(prop.get("items"), dict): + return "complex" + return "unknown" + + +def _union_body_props(spec: dict, member_paths: List[str]) -> "Dict[str, Any]": + """Merge request-body JSON schema properties across member ops. + First definition wins on name conflicts. Returns {name: schema}.""" + schemas = (spec.get("components") or {}).get("schemas") or {} + out: Dict[str, Any] = {} + for p in member_paths: + op = (spec.get("paths", {}).get(p) or {}).get("post") + if not isinstance(op, dict): + continue + body = (((op.get("requestBody") or {}).get("content") or {}) + .get("application/json") or {}).get("schema") or {} + if "$ref" in body: + body = _resolve_ref(body["$ref"], schemas) or {} + for name, prop in (body.get("properties") or {}).items(): + if name not in out: + out[name] = copy.deepcopy(prop) + return out + + +def _build_transform_body(props: List[Tuple[str, str]]) -> str: + """Go template serialising exactly the provided properties (complex + props with the string-vs-parsed dual mode, scalars via toJson). + Unlike request_body_transforms, always returns a template - SELECT + body building relies on it.""" + lines = ["{"] + lines.append('{{- $sep := "" -}}') + for name, kind in props: + if kind == "unknown": + continue + if kind == "complex": + value_expr = ( + '{{ if eq (kindOf .' + name + ') "string" }}' + '{{ .' + name + ' }}' + '{{ else }}' + '{{ toJson .' + name + ' }}' + '{{ end }}' + ) + else: + value_expr = '{{ toJson .' + name + ' }}' + lines.append( + '{{- if .' + name + ' }}{{ $sep }}"' + name + '": ' + value_expr + + '{{- $sep = "," -}}{{ end }}' + ) + lines.append("}") + return "\n".join(lines) + "\n" + + +def _build_envelope_schema(config: dict) -> dict: + result_props: Dict[str, Any] = { + "model": {"type": "string", "description": "Echo of the model name, where reported."}, + } + for fam, meta in (config.get("families") or {}).items(): + for name, schema in (meta.get("result_fields") or {}).items(): + result_props.setdefault(name, schema) + return { + "type": "object", + "description": "Union response envelope for Workers AI run operations (synthesised by stackql).", + "properties": { + "result": {"type": "object", "properties": result_props}, + "success": {"type": "boolean"}, + "errors": {"type": "array", "items": {"type": "object"}}, + "messages": {"type": "array", "items": {"type": "string"}}, + "contents": {"type": "string", + "description": "Raw response payload (binary or non-object results), used by contents-mode families."}, + }, + } + + +def _family_method(mode: str, input_schema_name: str, transform_body: str) -> dict: + m: dict = { + "config": {"requestBodyTranslate": {"algorithm": "naive"}}, + "operation": {"$ref": GENERIC_OP_REF}, + "request": { + "mediaType": "application/json", + "schema_override": {"$ref": _SCHEMA_REF_PREFIX + input_schema_name}, + "transform": {"type": "golang_template_json_v0.3.0", "body": transform_body}, + }, + } + if mode == "object": + m["response"] = { + "mediaType": "application/json", + "openAPIDocKey": "200", + "objectKey": "$.result", + } + else: # contents + m["response"] = { + "mediaType": "application/json", + "openAPIDocKey": "200", + "overrideMediaType": "application/json", + "transform": {"body": '[{"contents": {{ toJson . }}}]', + "type": "golang_template_text_v0.3.0"}, + } + return m + + +def process(provider_dir: Path, config_path: Path) -> int: + config = yaml.safe_load(config_path.read_text(encoding="utf-8")) + families: Dict[str, dict] = config.get("families") or {} + if not families: + logger.error("No families defined in %s", config_path) + return 1 + + gen_path = provider_dir / "services" / "ai.yaml" + spec = yaml.safe_load(gen_path.read_text(encoding="utf-8")) + paths = spec.get("paths") or {} + components = spec.setdefault("components", {}) + schemas = components.setdefault("schemas", {}) + resources = components.setdefault("x-stackQL-resources", {}) + + if GENERIC_PATH not in paths: + logger.error("Generic run path %s not found in generated ai.yaml", GENERIC_PATH) + return 1 + + # 1. Envelope schema + generic op response rewrite. + schemas[ENVELOPE_SCHEMA] = _build_envelope_schema(config) + generic_op = paths[GENERIC_PATH]["post"] + generic_op.setdefault("responses", {}).setdefault("200", {})["content"] = { + "application/json": {"schema": {"$ref": _SCHEMA_REF_PREFIX + ENVELOPE_SCHEMA}} + } + + # Map member path -> (resource, method) so we can drop them. + path_to_res: Dict[str, Tuple[str, str]] = {} + for r_name, r in resources.items(): + for m_name, m in (r.get("methods") or {}).items(): + op_ref = ((m.get("operation") or {}).get("$ref") or "") + parts = op_ref.split("/") + if len(parts) > 3 and parts[-1] == "post": + p = "/".join(parts[2:-1]).replace("~1", "/") + path_to_res[p] = (r_name, m_name) + + fam_count = 0 + dropped_paths = 0 + dropped_resources = 0 + all_union_props: Dict[str, Any] = {} + + for fam, meta in families.items(): + member_paths = [_model_path(m) for m in (meta.get("members") or [])] + present = [p for p in member_paths if p in paths] + if not present: + if fam in resources: + logger.debug("%s: members already collapsed - leaving existing resource", fam) + continue + logger.warning("%s: no member paths found and no existing resource - skipping", fam) + continue + + union = _union_body_props(spec, present) + for k, v in union.items(): + all_union_props.setdefault(k, copy.deepcopy(v)) + input_name = "stackqlAi" + _pascal(fam) + "RunInput" + schemas[input_name] = { + "type": "object", + "description": f"Union of request properties across the {fam} member models (synthesised by stackql).", + "properties": union, + } + prop_kinds = [(n, _prop_kind(p, schemas)) for n, p in union.items()] + transform_body = _build_transform_body(prop_kinds) + + resources[fam] = { + "id": f"cloudflare.ai.{fam}", + "name": fam, + "title": meta.get("title") or fam, + "methods": {"run": _family_method(meta.get("mode") or "object", input_name, transform_body)}, + "sqlVerbs": { + "select": [{"$ref": f"#/components/x-stackQL-resources/{fam}/methods/run"}], + "insert": [], "update": [], "delete": [], "replace": [], + }, + } + fam_count += 1 + + # Drop member paths + their per-model resources. + for p in present: + res_method = path_to_res.get(p) + if res_method: + r_name, m_name = res_method + r = resources.get(r_name) + if r and r_name != fam: + (r.get("methods") or {}).pop(m_name, None) + if not r.get("methods"): + resources.pop(r_name, None) + dropped_resources += 1 + paths.pop(p, None) + dropped_paths += 1 + + # 3. Generic ai.run escape hatch: same input/transform machinery, + # union of ALL family props, typed envelope select. + run_res = resources.get("run") + if run_res and all_union_props: + input_name = "stackqlAiRunInput" + schemas[input_name] = { + "type": "object", + "description": "Union of request properties across all Workers AI run models (synthesised by stackql).", + "properties": all_union_props, + } + prop_kinds = [(n, _prop_kind(p, schemas)) for n, p in all_union_props.items()] + m = run_res.get("methods", {}).get("run") + if m is not None: + m["config"] = {"requestBodyTranslate": {"algorithm": "naive"}} + m["request"] = { + "mediaType": "application/json", + "schema_override": {"$ref": _SCHEMA_REF_PREFIX + input_name}, + "transform": {"type": "golang_template_json_v0.3.0", + "body": _build_transform_body(prop_kinds)}, + } + m["response"] = { + "mediaType": "application/json", + "openAPIDocKey": "200", + "objectKey": "$.result", + } + # run is select-only: keeping the same method under insert too + # would render duplicate INSERT/SELECT doc examples for one op. + verbs = run_res.setdefault("sqlVerbs", {}) + verbs["select"] = [ + {"$ref": "#/components/x-stackQL-resources/run/methods/run"} + ] + verbs["insert"] = [] + + if fam_count: + with gen_path.open("w", encoding="utf-8") as f: + yaml.safe_dump(spec, f, sort_keys=False, default_flow_style=False, width=1000) + + logger.info("Created %d family resources; dropped %d per-model paths and %d per-model resources.", + fam_count, dropped_paths, dropped_resources) + return 0 + + +def main(argv: Optional[List[str]] = None) -> int: + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--provider-dir", default=str(PROVIDER_DIR)) + parser.add_argument("--config", default=str(CONFIG_PATH)) + parser.add_argument("-v", "--verbose", action="store_true") + args = parser.parse_args(argv) + + logging.basicConfig( + level=logging.DEBUG if args.verbose else logging.INFO, + format="%(asctime)s %(levelname)s %(message)s", + ) + + provider_dir = Path(args.provider_dir) + config_path = Path(args.config) + if not (provider_dir / "services" / "ai.yaml").exists(): + logger.error("ai.yaml not found under %s. Run `npm run generate-provider` first.", provider_dir) + return 1 + if not config_path.exists(): + logger.error("Config not found: %s", config_path) + return 1 + return process(provider_dir, config_path) + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/stackql_cloudflare/stackql_cloudflare_provider/assign_resource_names.py b/stackql_cloudflare/stackql_cloudflare_provider/assign_resource_names.py index fb3058b3dec..a872f9e5c38 100644 --- a/stackql_cloudflare/stackql_cloudflare_provider/assign_resource_names.py +++ b/stackql_cloudflare/stackql_cloudflare_provider/assign_resource_names.py @@ -1075,6 +1075,12 @@ def main(argv: list[str] | None = None) -> int: parser = argparse.ArgumentParser(description=__doc__) parser.add_argument("--reset", action="store_true", help="Reset all four stackql_* columns to their defaults, discarding manual edits.") + parser.add_argument("--strict", action="store_true", + help="Exit non-zero if any source operation has no existing mapping row in the " + "CSV, or if any row carries a hash-suffixed resource/method name (the " + "disambiguation fallback). Default rows ARE still written for the new " + "operations, so review them (tighten resource/method/verb, rename hashed " + "names) and re-run.") parser.add_argument("-v", "--verbose", action="store_true") args = parser.parse_args(argv) @@ -1135,6 +1141,31 @@ def main(argv: list[str] | None = None) -> int: write_csv(out_rows) logger.info("Wrote %d rows to %s (new=%d preserved=%d reset=%d dropped=%d)", len(out_rows), CSV_PATH, added, preserved, updated, len(removed_keys)) + if args.strict and added: + logger.error( + "--strict: %d operation(s) had no mapping row in the CSV. Default rows were " + "written (grep the log above for 'new op found') - review and curate the " + "stackql_resource_name / stackql_method_name / stackql_verb / stackql_object_key " + "columns, then re-run.", added) + return 2 + if args.strict: + # Hash-suffixed names are the pass-3 disambiguation fallback and + # are never an acceptable end state - fail so a human picks + # semantic names in the CSV (see the mapping heuristics in + # CLAUDE.md). + hashed = [r for r in out_rows + if re.search(r"_[0-9a-f]{6}$", r["stackql_resource_name"]) + or re.search(r"_[0-9a-f]{6}$", r["stackql_method_name"])] + if hashed: + for r in hashed: + logger.error("--strict: hash-suffixed name: %s %s %s -> %s.%s", + r["filename"], r["verb"].upper(), r["path"], + r["stackql_resource_name"], r["stackql_method_name"]) + logger.error( + "--strict: %d row(s) carry hash-suffixed resource/method names " + "(disambiguation fallback). Rename them in the CSV, then re-run.", + len(hashed)) + return 2 return 0 diff --git a/stackql_cloudflare/stackql_cloudflare_provider/octet_stream_docs.py b/stackql_cloudflare/stackql_cloudflare_provider/octet_stream_docs.py new file mode 100644 index 00000000000..6ad7f7e37a2 --- /dev/null +++ b/stackql_cloudflare/stackql_cloudflare_provider/octet_stream_docs.py @@ -0,0 +1,247 @@ +"""Rewrite doc examples for methods whose request body is +`application/octet-stream`. + +Companion to `octet_stream_requests.py`. That pass drops the `naive` +requestBodyTranslate from octet-stream request methods and presents a +single required `value` body column via a `schema_override` wrapper. +With naive translation gone, the body column is only addressable with +the `data__` prefix - but docgen renders body columns unprefixed (or +omits them entirely when it can't project the octet-stream schema). + +This pass patches the generated markdown so each affected method's SQL +example shows the body column as `data__value`: + + REPLACE cloudflare.kv.values + SET data__value = '{{ value }}' + WHERE account_id = '...' AND namespace_id = '...' AND key_name = '...'; + +Targets are discovered from the generated provider yamls (any resource +method carrying `request.mediaType: application/octet-stream`), so the +two passes can never drift apart. Only the matched method's TabItem SQL +block is touched - all other examples on the page are left alone. + +Runs after `sanitize_docs.py` in the `generate-docs` post-pass chain. +Idempotent. +""" +from __future__ import annotations + +import argparse +import logging +import re +import sys +from pathlib import Path +from typing import Dict, List, Optional, Tuple + +import yaml + + +logger = logging.getLogger(__name__) + +PKG_DIR = Path(__file__).resolve().parent +PROVIDER_DIR = ( + PKG_DIR.parent + / "provider-dev" / "openapi" / "src" / "cloudflare" / "v00.00.00000" +) +DOCS_DIR = PKG_DIR.parent / "website" / "docs" / "services" + +_OCTET_STREAM = "application/octet-stream" + +_VERB_TO_SECTION = { + "insert": "INSERT", + "update": "UPDATE", + "replace": "REPLACE", +} + + +def _discover_targets(provider_dir: Path) -> List[Dict]: + """Walk generated service yamls; return one record per resource + method with an octet-stream request block: + {service, resource, method, sql_verb, body_cols}.""" + out: List[Dict] = [] + for svc_path in sorted((provider_dir / "services").glob("*.yaml")): + spec = yaml.safe_load(svc_path.read_text(encoding="utf-8")) + if not isinstance(spec, dict): + continue + components = spec.get("components") or {} + schemas = components.get("schemas") or {} + resources = components.get("x-stackQL-resources") or {} + for r_name, r in resources.items(): + methods = r.get("methods") or {} + sql_verbs = r.get("sqlVerbs") or {} + for m_name, m in methods.items(): + req = m.get("request") or {} + if req.get("mediaType") != _OCTET_STREAM: + continue + verb = None + for sv, refs in sql_verbs.items(): + for x in (refs or []): + ref = (x or {}).get("$ref") or "" + if ref.endswith("/methods/" + m_name): + verb = sv + if verb not in _VERB_TO_SECTION: + logger.debug("%s.%s.%s: no insert/update/replace sqlVerb - skipping", + svc_path.stem, r_name, m_name) + continue + cols = None + so_ref = (req.get("schema_override") or {}).get("$ref") or "" + wrapper = schemas.get(so_ref.split("/")[-1]) if so_ref else None + if isinstance(wrapper, dict): + cols = wrapper.get("required") or list((wrapper.get("properties") or {}).keys()) + out.append({ + "service": svc_path.stem, + "resource": r_name, + "method": m_name, + "sql_verb": verb, + "body_cols": cols or ["value"], + }) + return out + + +def _rewrite_insert_sql(sql: str, body_cols: List[str]) -> Optional[str]: + """Rewrite an INSERT example: drop any pre-existing (data__-prefixed + or bare) body columns and re-insert them data__-prefixed at the top + of the column list, with matching '{{ col }}' select values.""" + lines = sql.split("\n") + try: + open_idx = next(i for i, l in enumerate(lines) if l.rstrip().endswith("(")) + close_idx = next(i for i in range(open_idx + 1, len(lines)) if lines[i].strip() == ")") + select_idx = next(i for i in range(close_idx, len(lines)) if lines[i].strip().upper() == "SELECT") + except StopIteration: + return None + vals_end = len(lines) + for i in range(select_idx + 1, len(lines)): + s = lines[i].strip() + if s.upper() == "RETURNING" or s == ";": + vals_end = i + break + + cols = [l.strip().rstrip(",") for l in lines[open_idx + 1:close_idx] if l.strip()] + vals = [l.strip().rstrip(",") for l in lines[select_idx + 1:vals_end] if l.strip()] + if len(cols) != len(vals): + return None + + drop = {c for c in body_cols} | {"data__" + c for c in body_cols} + kept = [(c, v) for c, v in zip(cols, vals) if c not in drop] + injected = [("data__" + c, "'{{ " + c + " }}' /* required */") for c in body_cols] + pairs = injected + kept + + new_cols = [c + ("," if i < len(pairs) - 1 else "") for i, (c, _) in enumerate(pairs)] + new_vals = [v + ("," if i < len(pairs) - 1 else "") for i, (_, v) in enumerate(pairs)] + return "\n".join( + lines[:open_idx + 1] + new_cols + lines[close_idx:select_idx + 1] + + new_vals + lines[vals_end:] + ) + + +def _rewrite_set_sql(sql: str, body_cols: List[str]) -> Optional[str]: + """Rewrite a REPLACE/UPDATE example: the SET block becomes exactly + the data__-prefixed body columns (replacing '-- No updatable + properties' placeholders or unprefixed column lines).""" + lines = sql.split("\n") + try: + set_idx = next(i for i, l in enumerate(lines) if l.strip().upper().startswith("SET")) + where_idx = next(i for i in range(set_idx + 1, len(lines)) if l_upper(lines[i]).startswith("WHERE")) + except StopIteration: + return None + set_lines = ["data__" + c + " = '{{ " + c + " }}'" for c in body_cols] + set_lines = [l + "," for l in set_lines[:-1]] + [set_lines[-1]] + return "\n".join(lines[:set_idx + 1] + set_lines + lines[where_idx:]) + + +def l_upper(line: str) -> str: + return line.strip().upper() + + +def _patch_page(page: Path, target: Dict) -> bool: + """Patch one method's SQL example on one page. Returns True if the + page content changed.""" + text = page.read_text(encoding="utf-8") + section_word = _VERB_TO_SECTION[target["sql_verb"]] + section_re = re.compile( + r"(## `" + section_word + r"` examples.*?)(?=\n## |\Z)", re.DOTALL) + sec_m = section_re.search(text) + if not sec_m: + logger.warning("%s: no `%s` examples section found", page, section_word) + return False + section = sec_m.group(1) + + tab_re = re.compile( + r'(.*?)', re.DOTALL) + tab_m = tab_re.search(section) + if not tab_m: + logger.warning("%s: no TabItem for method %s in `%s` section", + page, target["method"], section_word) + return False + tab = tab_m.group(1) + + sql_re = re.compile(r"```sql\n(.*?)```", re.DOTALL) + sql_m = sql_re.search(tab) + if not sql_m: + logger.warning("%s: no sql block in TabItem %s", page, target["method"]) + return False + sql = sql_m.group(1) + + if any(("data__" + c) in sql for c in target["body_cols"]): + return False # already patched + + if target["sql_verb"] == "insert": + new_sql = _rewrite_insert_sql(sql, target["body_cols"]) + else: + new_sql = _rewrite_set_sql(sql, target["body_cols"]) + if new_sql is None: + logger.warning("%s: could not parse sql example for %s.%s", + page, target["resource"], target["method"]) + return False + if new_sql == sql: + return False + + new_tab = tab.replace(sql_m.group(0), "```sql\n" + new_sql + "```") + new_section = section.replace(tab, new_tab) + # newline='\n' so Windows doesn't rewrite the whole file to CRLF + page.write_text(text.replace(section, new_section), encoding="utf-8", newline="\n") + return True + + +def main(argv: Optional[List[str]] = None) -> int: + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--provider-dir", default=str(PROVIDER_DIR), + help=f"Provider root containing services/. Default: {PROVIDER_DIR}") + parser.add_argument("--docs-dir", default=str(DOCS_DIR), + help=f"Generated docs root (services/). Default: {DOCS_DIR}") + parser.add_argument("-v", "--verbose", action="store_true") + args = parser.parse_args(argv) + + logging.basicConfig( + level=logging.DEBUG if args.verbose else logging.INFO, + format="%(asctime)s %(levelname)s %(message)s", + ) + + provider_dir = Path(args.provider_dir) + docs_dir = Path(args.docs_dir) + if not (provider_dir / "services").exists(): + logger.error("services/ dir not found at %s.", provider_dir / "services") + return 1 + if not docs_dir.exists(): + logger.error("docs dir not found at %s. Run `npm run generate-docs` first.", docs_dir) + return 1 + + targets = _discover_targets(provider_dir) + logger.info("Discovered %d octet-stream request methods.", len(targets)) + + patched = 0 + for t in targets: + page = docs_dir / t["service"] / t["resource"] / "index.md" + if not page.exists(): + logger.warning("Doc page not found: %s", page) + continue + if _patch_page(page, t): + patched += 1 + logger.info("Patched %s.%s.%s (%s example) -> data__ body columns", + t["service"], t["resource"], t["method"], t["sql_verb"]) + + logger.info("Patched %d doc examples.", patched) + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/stackql_cloudflare/stackql_cloudflare_provider/octet_stream_requests.py b/stackql_cloudflare/stackql_cloudflare_provider/octet_stream_requests.py new file mode 100644 index 00000000000..a1bcd32a5d6 --- /dev/null +++ b/stackql_cloudflare/stackql_cloudflare_provider/octet_stream_requests.py @@ -0,0 +1,283 @@ +"""Rewrite resource methods whose request body is `application/octet-stream`. + +Why: stackql's `naive` requestBodyTranslate (and the generated +request.transform blocks) both assume a JSON request body built from the +SET clause. A handful of Cloudflare endpoints (KV value PUT, Workers AI +binary-input models, DLP dataset uploads) take the raw request body as +an opaque octet-stream payload instead - there are no named body +properties to translate, the whole body IS the value. + +For each such method this pass: + +1. Injects a wrapper schema into the service's `components/schemas`: + + stackqlWorkersKvValueBody: + type: object + required: [value] + properties: + value: + + The `stackql` prefix marks it as synthesised for stackql (it does not + exist in the upstream spec). + +2. Drops the `config.requestBodyTranslate.algorithm = naive` block from + the resource method (naive translation would JSON-encode the body map + `{"value": "..."}` instead of sending the raw payload). + +3. Attaches a `request` block that presents a single required `value` + column to the planner (via `schema_override`) and splats it verbatim + onto the wire as the raw octet-stream body: + + request: + mediaType: application/octet-stream + required: + - value + schema_override: + $ref: '#/components/schemas/stackqlWorkersKvValueBody' + transform: + type: golang_template_json_v0.1.0 + body: '{{ .value }}' + +Callers then write e.g.: + + REPLACE cloudflare.kv.values + SET data__value = '0.10.557' + WHERE account_id = '...' AND namespace_id = '...' AND key_name = '...'; + +Note the `data__` prefix is mandatory for these methods - with naive +translation removed, body columns are only addressable via `data__`. +The companion docs pass (`octet_stream_docs.py`) rewrites the doc +examples accordingly. + +This step runs after `request_body_transforms.py` in the +`generate-provider` post-pass chain. Idempotent. +""" +from __future__ import annotations + +import argparse +import logging +import sys +from pathlib import Path +from typing import Any, Dict, List, Optional, Tuple + +import yaml + + +logger = logging.getLogger(__name__) + + +_YAML_1_1_BOOL_LITERALS = frozenset({ + "y", "Y", "yes", "Yes", "YES", + "n", "N", "no", "No", "NO", + "true", "True", "TRUE", + "false", "False", "FALSE", + "on", "On", "ON", + "off", "Off", "OFF", +}) + + +def _represent_str_yaml11_safe(dumper, data): + style = "'" if data in _YAML_1_1_BOOL_LITERALS else None + return dumper.represent_scalar("tag:yaml.org,2002:str", data, style=style) + + +yaml.SafeDumper.add_representer(str, _represent_str_yaml11_safe) + + +PKG_DIR = Path(__file__).resolve().parent +PROVIDER_DIR = ( + PKG_DIR.parent + / "provider-dev" / "openapi" / "src" / "cloudflare" / "v00.00.00000" +) +SOURCE_DIR = PKG_DIR.parent / "provider-dev" / "source" + +_WRITE_VERBS = ("put", "post", "patch") +_OCTET_STREAM = "application/octet-stream" +_SCHEMA_REF_PREFIX = "#/components/schemas/" + + +def _pascal(s: str) -> str: + out = "".join(part[:1].upper() + part[1:] for part in s.replace("-", "_").split("_") if part) + return out or "Body" + + +def _wrapper_schema_name(body_schema: dict, op: dict) -> str: + """Deterministic name for the injected wrapper schema, always + `stackql`-prefixed. From the body $ref name if present, else from the + operationId.""" + ref = body_schema.get("$ref") + if isinstance(ref, str) and ref.startswith(_SCHEMA_REF_PREFIX): + base = ref[len(_SCHEMA_REF_PREFIX):] + else: + base = op.get("operationId") or "octet_stream" + return "stackql" + _pascal(base) + "Body" + + +def _find_octet_stream_ops(source_spec: dict) -> Dict[Tuple[str, str], Tuple[str, dict]]: + """Return {(path, verb): (wrapper_name, body_schema)} for every + write-verb op whose request body is application/octet-stream.""" + out: Dict[Tuple[str, str], Tuple[str, dict]] = {} + for path, item in (source_spec.get("paths") or {}).items(): + if not isinstance(item, dict): + continue + for verb in _WRITE_VERBS: + op = item.get(verb) + if not isinstance(op, dict): + continue + content = ((op.get("requestBody") or {}).get("content") or {}) + mt_spec = content.get(_OCTET_STREAM) + if not isinstance(mt_spec, dict): + continue + schema = mt_spec.get("schema") or {"type": "string", "format": "binary"} + out[(path, verb)] = (_wrapper_schema_name(schema, op), schema) + return out + + +def _op_ref_to_path_verb(op_ref: str) -> Tuple[str, str]: + parts = op_ref.split("/") + verb = parts[-1] + encoded = "/".join(parts[2:-1]) + path = encoded.replace("~1", "/") + return path, verb + + +def _build_wrapper_schema(body_schema: dict) -> dict: + """The synthetic single-column body schema presented to the planner.""" + value_schema: Any + ref = body_schema.get("$ref") + if isinstance(ref, str): + value_schema = {"$ref": ref} + else: + value_schema = dict(body_schema) + return { + "type": "object", + "required": ["value"], + "properties": { + "value": value_schema, + }, + } + + +def _rebuild_method(m: dict, wrapper_name: str) -> dict: + """Return the method dict with naive requestBodyTranslate removed and + the octet-stream request block attached, preserving a stable key + order (config, operation, request, response, everything else).""" + config = m.get("config") + if isinstance(config, dict): + rbt = config.get("requestBodyTranslate") + if isinstance(rbt, dict) and rbt.get("algorithm") == "naive": + config = {k: v for k, v in config.items() if k != "requestBodyTranslate"} + request = { + "mediaType": _OCTET_STREAM, + "required": ["value"], + "schema_override": {"$ref": _SCHEMA_REF_PREFIX + wrapper_name}, + "transform": { + "type": "golang_template_json_v0.1.0", + "body": "{{ .value }}", + }, + } + out: dict = {} + if config: + out["config"] = config + if "operation" in m: + out["operation"] = m["operation"] + out["request"] = request + if "response" in m: + out["response"] = m["response"] + for k, v in m.items(): + if k not in ("config", "operation", "request", "response"): + out[k] = v + return out + + +def process_service_file(generated_path: Path, source_path: Path) -> Dict[str, int]: + source_spec = yaml.safe_load(source_path.read_text(encoding="utf-8")) + if not isinstance(source_spec, dict): + return {"methods": 0} + targets = _find_octet_stream_ops(source_spec) + if not targets: + return {"methods": 0} + + generated_spec = yaml.safe_load(generated_path.read_text(encoding="utf-8")) + if not isinstance(generated_spec, dict): + return {"methods": 0} + + components = generated_spec.setdefault("components", {}) + schemas = components.setdefault("schemas", {}) + resources = components.get("x-stackQL-resources") or {} + method_count = 0 + + for r_name, r in resources.items(): + methods = r.get("methods") or {} + for m_name in list(methods): + m = methods[m_name] + op_ref = ((m.get("operation") or {}).get("$ref") or "") + if not op_ref: + continue + try: + p, v = _op_ref_to_path_verb(op_ref) + except Exception: + continue + target = targets.get((p, v)) + if not target: + continue + wrapper_name, body_schema = target + already = (m.get("request") or {}).get("mediaType") == _OCTET_STREAM + schemas.setdefault(wrapper_name, _build_wrapper_schema(body_schema)) + methods[m_name] = _rebuild_method(m, wrapper_name) + if not already: + method_count += 1 + logger.debug("%s: %s.%s -> octet-stream request via %s%s", + generated_path.name, r_name, m_name, wrapper_name, + " (already applied)" if already else "") + + if method_count: + with generated_path.open("w", encoding="utf-8") as f: + yaml.safe_dump(generated_spec, f, sort_keys=False, default_flow_style=False, width=1000) + + return {"methods": method_count} + + +def main(argv: Optional[List[str]] = None) -> int: + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--provider-dir", default=str(PROVIDER_DIR), + help=f"Provider root containing services/. Default: {PROVIDER_DIR}") + parser.add_argument("--source-dir", default=str(SOURCE_DIR), + help=f"Source yamls dir (for body schema lookup). Default: {SOURCE_DIR}") + parser.add_argument("-v", "--verbose", action="store_true") + args = parser.parse_args(argv) + + logging.basicConfig( + level=logging.DEBUG if args.verbose else logging.INFO, + format="%(asctime)s %(levelname)s %(message)s", + ) + + services_dir = Path(args.provider_dir) / "services" + source_dir = Path(args.source_dir) + if not services_dir.exists(): + logger.error("services/ dir not found at %s. Run `npm run generate-provider` first.", services_dir) + return 1 + if not source_dir.exists(): + logger.error("source/ dir not found at %s.", source_dir) + return 1 + + total_methods = 0 + touched_files = 0 + for generated_path in sorted(services_dir.glob("*.yaml")): + source_path = source_dir / generated_path.name + if not source_path.exists(): + continue + stats = process_service_file(generated_path, source_path) + if stats["methods"]: + touched_files += 1 + total_methods += stats["methods"] + logger.info("%s: rewrote %d octet-stream request methods", + generated_path.name, stats["methods"]) + + logger.info("Rewrote %d octet-stream request methods across %d files.", + total_methods, touched_files) + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/stackql_cloudflare/stackql_cloudflare_provider/sanitize_docs.py b/stackql_cloudflare/stackql_cloudflare_provider/sanitize_docs.py index 9d6931a11c8..ba03c936921 100644 --- a/stackql_cloudflare/stackql_cloudflare_provider/sanitize_docs.py +++ b/stackql_cloudflare/stackql_cloudflare_provider/sanitize_docs.py @@ -298,7 +298,8 @@ def sanitize_file(path: Path, analytics_pages: set[Path]) -> dict: text, analytics_n = _inject_analytics_callout(text) if text != original: - path.write_text(text, encoding="utf-8") + # newline='\n' so Windows doesn't rewrite the whole file to CRLF + path.write_text(text, encoding="utf-8", newline="\n") return { "code": code_n, "br": br_n, "cf_link": link_n, "anchor": anchor_n, "bogus_type": type_n, "analytics": analytics_n, diff --git a/stackql_cloudflare/stackql_cloudflare_provider/select_response_fixes.py b/stackql_cloudflare/stackql_cloudflare_provider/select_response_fixes.py new file mode 100644 index 00000000000..8734fd99c1f --- /dev/null +++ b/stackql_cloudflare/stackql_cloudflare_provider/select_response_fixes.py @@ -0,0 +1,202 @@ +"""Fix response shapes for resources whose SELECT would yield no columns. + +Driven by `provider-dev/config/select_response_fixes.yaml`. Targets +operations whose upstream 200 response is untyped (`{type: object}` +items), a scalar array, a dynamic-keyed object, a raw text body, or +missing entirely - all of which make DESCRIBE return zero columns and +the meta-route test flag the resource as non-selectable. + +Fix kinds (see the config header for full semantics): item_schema, +scalar_rows, result_to_contents, array_items_contents, contents, +add_200_contents. All except item_schema rewrite the op's 200 schema to +match the transform output, attach a `response.transform` to every +resource method referencing the op (binary_responses.py pattern), and +drop the method's objectKey. + +Runs after `ai_task_families.py` in the generate-provider chain. +Idempotent - fixes overwrite deterministically. +""" +from __future__ import annotations + +import argparse +import copy +import logging +import sys +from pathlib import Path +from typing import Any, Dict, List, Optional, Tuple + +import yaml + + +logger = logging.getLogger(__name__) + + +_YAML_1_1_BOOL_LITERALS = frozenset({ + "y", "Y", "yes", "Yes", "YES", + "n", "N", "no", "No", "NO", + "true", "True", "TRUE", + "false", "False", "FALSE", + "on", "On", "ON", + "off", "Off", "OFF", +}) + + +def _represent_str_yaml11_safe(dumper, data): + style = "'" if data in _YAML_1_1_BOOL_LITERALS else None + return dumper.represent_scalar("tag:yaml.org,2002:str", data, style=style) + + +yaml.SafeDumper.add_representer(str, _represent_str_yaml11_safe) + + +PKG_DIR = Path(__file__).resolve().parent +PROVIDER_DIR = ( + PKG_DIR.parent + / "provider-dev" / "openapi" / "src" / "cloudflare" / "v00.00.00000" +) +CONFIG_PATH = PKG_DIR.parent / "provider-dev" / "config" / "select_response_fixes.yaml" + +_SCHEMA_REF_PREFIX = "#/components/schemas/" +# Text transforms receive the RAW response body string - only `{{ . }}` / +# `{{ toJson . }}` make sense there. Kinds that access `.result` need the +# json transform type, which parses the body first (verified live: +# text-type `.result` access errors out and produces an empty body). +_TEXT_TRANSFORM = "golang_template_text_v0.3.0" +_JSON_TRANSFORM = "golang_template_json_v0.3.0" +_JSON_KINDS = ("scalar_rows", "result_to_contents", "array_items_contents") + + +def _row_schema(props: Dict[str, Any]) -> dict: + return {"type": "object", "properties": props} + + +def _transform_for(kind: str, column: str) -> str: + if kind == "scalar_rows": + return ('[{{ range $i, $v := .result }}{{ if $i }},{{ end }}' + '{"' + column + '": {{ toJson $v }}}{{ end }}]') + if kind == "result_to_contents": + return '[{"contents": {{ toJson .result }}}]' + if kind == "array_items_contents": + return ('[{{ range $i, $v := .result }}{{ if $i }},{{ end }}' + '{"contents": {{ toJson $v }}}{{ end }}]') + # contents / add_200_contents + return '[{"contents": {{ toJson . }}}]' + + +def _deref_inline(schema: Any, schemas: Dict[str, Any]) -> Any: + """Resolve a top-level $ref to a deep copy so shared component + schemas are never mutated.""" + hops = 0 + while isinstance(schema, dict) and "$ref" in schema and hops < 3: + target = schemas.get(schema["$ref"][len(_SCHEMA_REF_PREFIX):]) \ + if schema["$ref"].startswith(_SCHEMA_REF_PREFIX) else None + if target is None: + return schema + schema = copy.deepcopy(target) + hops += 1 + return schema + + +def _methods_for_op(resources: dict, path: str, verb: str) -> List[Tuple[str, str, dict]]: + out = [] + for r_name, r in resources.items(): + for m_name, m in (r.get("methods") or {}).items(): + op_ref = ((m.get("operation") or {}).get("$ref") or "") + parts = op_ref.split("/") + if len(parts) > 3 and parts[-1] == verb: + p = "/".join(parts[2:-1]).replace("~1", "/") + if p == path: + out.append((r_name, m_name, m)) + return out + + +def apply_fix(spec: dict, fix: dict) -> bool: + path, verb, kind = fix["path"], fix["verb"], fix["kind"] + column = fix.get("column", "contents") + op = (spec.get("paths", {}).get(path) or {}).get(verb) + if not isinstance(op, dict): + logger.warning("op not found: %s %s", verb.upper(), path) + return False + schemas = (spec.get("components") or {}).get("schemas") or {} + responses = op.setdefault("responses", {}) + r200 = responses.setdefault("200", {"description": "OK"}) + + if kind == "item_schema": + content = (r200.get("content") or {}).get("application/json") + if not isinstance(content, dict): + logger.warning("item_schema: no 200 json content for %s %s", verb, path) + return False + env = _deref_inline(content.get("schema") or {}, schemas) + result = (env.get("properties") or {}).get("result") + if not isinstance(result, dict): + logger.warning("item_schema: no result property for %s %s", verb, path) + return False + result = _deref_inline(result, schemas) + result["items"] = copy.deepcopy(fix["schema"]) + result["type"] = "array" + env.setdefault("properties", {})["result"] = result + content["schema"] = env + return True + + # All remaining kinds: rewrite the 200 schema to the transform's row + # shape and attach the transform on every referencing method. + row_props = {column: {"type": "string"}} if kind == "scalar_rows" else {"contents": {"type": "string"}} + if kind == "scalar_rows" and "column_description" in fix: + row_props[column]["description"] = fix["column_description"] + r200["content"] = {"application/json": {"schema": _row_schema(row_props)}} + + resources = ((spec.get("components") or {}).get("x-stackQL-resources") or {}) + hit = False + for r_name, m_name, m in _methods_for_op(resources, path, verb): + ttype = _JSON_TRANSFORM if kind in _JSON_KINDS else _TEXT_TRANSFORM + m["response"] = { + "mediaType": "application/json", + "openAPIDocKey": "200", + "overrideMediaType": "application/json", + "transform": {"body": _transform_for(kind, column), "type": ttype}, + } + hit = True + logger.debug("%s: %s.%s <- %s", path, r_name, m_name, kind) + if not hit: + logger.warning("no resource method references %s %s", verb.upper(), path) + return hit + + +def main(argv: Optional[List[str]] = None) -> int: + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--provider-dir", default=str(PROVIDER_DIR)) + parser.add_argument("--config", default=str(CONFIG_PATH)) + parser.add_argument("-v", "--verbose", action="store_true") + args = parser.parse_args(argv) + + logging.basicConfig( + level=logging.DEBUG if args.verbose else logging.INFO, + format="%(asctime)s %(levelname)s %(message)s", + ) + + config = yaml.safe_load(Path(args.config).read_text(encoding="utf-8")) + fixes = config.get("fixes") or [] + by_service: Dict[str, List[dict]] = {} + for f in fixes: + by_service.setdefault(f["service"], []).append(f) + + services_dir = Path(args.provider_dir) / "services" + total = 0 + for svc, svc_fixes in sorted(by_service.items()): + svc_path = services_dir / f"{svc}.yaml" + if not svc_path.exists(): + logger.warning("service yaml missing: %s", svc_path) + continue + spec = yaml.safe_load(svc_path.read_text(encoding="utf-8")) + applied = sum(1 for f in svc_fixes if apply_fix(spec, f)) + if applied: + with svc_path.open("w", encoding="utf-8") as fh: + yaml.safe_dump(spec, fh, sort_keys=False, default_flow_style=False, width=1000) + logger.info("%s: applied %d/%d fixes", svc, applied, len(svc_fixes)) + total += applied + logger.info("Applied %d response fixes.", total) + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/stackql_cloudflare/stackql_cloudflare_provider/split.py b/stackql_cloudflare/stackql_cloudflare_provider/split.py index 7905ae9fda3..afc6695b071 100644 --- a/stackql_cloudflare/stackql_cloudflare_provider/split.py +++ b/stackql_cloudflare/stackql_cloudflare_provider/split.py @@ -80,8 +80,8 @@ def _transitive_refs(seed: Set[str], schemas: Dict[str, Any]) -> Set[str]: "ai": "ai", "ai-gateway": "ai_gateway", "ai-security": "ai_security", - "ai-search": "aisearch", - "aisearch": "aisearch", + "ai-search": "ai_search", + "aisearch": "ai_search", "alerting": "alerting", "api_gateway": "api_gateway", "api-gateway": "api_gateway", diff --git a/stackql_cloudflare/website/docs/index.md b/stackql_cloudflare/website/docs/index.md index 67f36019e56..868e51b8a0f 100644 --- a/stackql_cloudflare/website/docs/index.md +++ b/stackql_cloudflare/website/docs/index.md @@ -22,7 +22,7 @@ The connectivity cloud - DNS, CDN, Zero Trust, Workers, and more. :::info[Provider Summary] total services: __108__ -total resources: __1375__ +total resources: __1235__ ::: @@ -79,7 +79,7 @@ stackql.exe shell --auth=$Auth addressing
ai
ai_gateway
-aisearch
+ai_search
alerting
api_gateway
argo
diff --git a/stackql_cloudflare/website/docs/services/addressing/accounts/index.md b/stackql_cloudflare/website/docs/services/addressing/accounts/index.md deleted file mode 100644 index ca9f57dd3ff..00000000000 --- a/stackql_cloudflare/website/docs/services/addressing/accounts/index.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: accounts -hide_title: false -hide_table_of_contents: false -keywords: - - accounts - - addressing - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an accounts resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, address_map_idAdd an account as a member of a particular address map.
account_id, address_map_idRemove an account as a member of a particular address map.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
- -## `REPLACE` examples - - - - -Add an account as a member of a particular address map. - -```sql -REPLACE cloudflare.addressing.accounts -SET --- No updatable properties -WHERE -account_id = '{{ account_id }}' --required -AND address_map_id = '{{ address_map_id }}' --required -RETURNING -errors, -messages, -result_info, -success; -``` - - - - -## `DELETE` examples - - - - -Remove an account as a member of a particular address map. - -```sql -DELETE FROM cloudflare.addressing.accounts -WHERE account_id = '{{ account_id }}' --required -AND address_map_id = '{{ address_map_id }}' --required -; -``` - - diff --git a/stackql_cloudflare/website/docs/services/addressing/address_maps/index.md b/stackql_cloudflare/website/docs/services/addressing/address_maps/index.md index 97d7d11d3ab..025f6340947 100644 --- a/stackql_cloudflare/website/docs/services/addressing/address_maps/index.md +++ b/stackql_cloudflare/website/docs/services/addressing/address_maps/index.md @@ -213,6 +213,48 @@ The following methods are available for this resource: Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted. + + + + account_id, address_map_id + + Remove an account as a member of a particular address map. + + + + + account_id, address_map_id + + Add an account as a member of a particular address map. + + + + + ip_address, address_map_id, account_id + + Remove an IP from a particular address map. + + + + + ip_address, address_map_id, account_id + + Add an IP from a prefix owned by the account to a particular address map. + + + + + zone_id, address_map_id, account_id + + Remove a zone as a member of a particular address map. + + + + + zone_id, address_map_id, account_id + + Add a zone as a member of a particular address map. + @@ -239,6 +281,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string + + + string + + + + + string + The Cloudflare zone ID. + @@ -413,3 +465,89 @@ AND account_id = '{{ account_id }}' --required ``` + + +## Lifecycle Methods + + + + +Remove an account as a member of a particular address map. + +```sql +EXEC cloudflare.addressing.address_maps.remove_account +@account_id='{{ account_id }}' --required, +@address_map_id='{{ address_map_id }}' --required +; +``` + + + +Add an account as a member of a particular address map. + +```sql +EXEC cloudflare.addressing.address_maps.add_account +@account_id='{{ account_id }}' --required, +@address_map_id='{{ address_map_id }}' --required +; +``` + + + +Remove an IP from a particular address map. + +```sql +EXEC cloudflare.addressing.address_maps.remove_ip +@ip_address='{{ ip_address }}' --required, +@address_map_id='{{ address_map_id }}' --required, +@account_id='{{ account_id }}' --required +; +``` + + + +Add an IP from a prefix owned by the account to a particular address map. + +```sql +EXEC cloudflare.addressing.address_maps.add_ip +@ip_address='{{ ip_address }}' --required, +@address_map_id='{{ address_map_id }}' --required, +@account_id='{{ account_id }}' --required +; +``` + + + +Remove a zone as a member of a particular address map. + +```sql +EXEC cloudflare.addressing.address_maps.remove_zone +@zone_id='{{ zone_id }}' --required, +@address_map_id='{{ address_map_id }}' --required, +@account_id='{{ account_id }}' --required +; +``` + + + +Add a zone as a member of a particular address map. + +```sql +EXEC cloudflare.addressing.address_maps.add_zone +@zone_id='{{ zone_id }}' --required, +@address_map_id='{{ address_map_id }}' --required, +@account_id='{{ account_id }}' --required +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/addressing/index.md b/stackql_cloudflare/website/docs/services/addressing/index.md index eaa76e829a6..a165c915e3d 100644 --- a/stackql_cloudflare/website/docs/services/addressing/index.md +++ b/stackql_cloudflare/website/docs/services/addressing/index.md @@ -18,19 +18,17 @@ addressing service documentation. :::info[Service Summary] -total resources: __15__ +total resources: __11__ ::: ## Resources
-accounts
address_maps
advertisement_status
bgp_prefixes
delegations
-ips
leases
loa_documents
@@ -39,8 +37,6 @@ total resources: __15__ regional_hostnames
regions
service_bindings
-services
-validate
-zones +services
\ No newline at end of file diff --git a/stackql_cloudflare/website/docs/services/addressing/ips/index.md b/stackql_cloudflare/website/docs/services/addressing/ips/index.md deleted file mode 100644 index ca8a0e1b9a1..00000000000 --- a/stackql_cloudflare/website/docs/services/addressing/ips/index.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: ips -hide_title: false -hide_table_of_contents: false -keywords: - - ips - - addressing - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an ips resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
ip_address, address_map_id, account_idAdd an IP from a prefix owned by the account to a particular address map.
ip_address, address_map_id, account_idRemove an IP from a particular address map.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `REPLACE` examples - - - - -Add an IP from a prefix owned by the account to a particular address map. - -```sql -REPLACE cloudflare.addressing.ips -SET --- No updatable properties -WHERE -ip_address = '{{ ip_address }}' --required -AND address_map_id = '{{ address_map_id }}' --required -AND account_id = '{{ account_id }}' --required -RETURNING -errors, -messages, -result_info, -success; -``` - - - - -## `DELETE` examples - - - - -Remove an IP from a particular address map. - -```sql -DELETE FROM cloudflare.addressing.ips -WHERE ip_address = '{{ ip_address }}' --required -AND address_map_id = '{{ address_map_id }}' --required -AND account_id = '{{ account_id }}' --required -; -``` - - diff --git a/stackql_cloudflare/website/docs/services/addressing/prefixes/index.md b/stackql_cloudflare/website/docs/services/addressing/prefixes/index.md index c006633dcdd..97620040d77 100644 --- a/stackql_cloudflare/website/docs/services/addressing/prefixes/index.md +++ b/stackql_cloudflare/website/docs/services/addressing/prefixes/index.md @@ -310,6 +310,13 @@ The following methods are available for this resource: Delete an unapproved prefix owned by the account. + + + + prefix_id, account_id + + Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership. + @@ -550,3 +557,25 @@ AND account_id = '{{ account_id }}' --required ``` + + +## Lifecycle Methods + + + + +Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership. + +```sql +EXEC cloudflare.addressing.prefixes.validate_prefix +@prefix_id='{{ prefix_id }}' --required, +@account_id='{{ account_id }}' --required +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/addressing/validate/index.md b/stackql_cloudflare/website/docs/services/addressing/validate/index.md deleted file mode 100644 index e8c942a0dbb..00000000000 --- a/stackql_cloudflare/website/docs/services/addressing/validate/index.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: validate -hide_title: false -hide_table_of_contents: false -keywords: - - validate - - addressing - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a validate resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
prefix_id, account_idTriggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
stringThe IP prefix ID.
- -## `INSERT` examples - - - - -Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership. - -```sql -INSERT INTO cloudflare.addressing.validate ( -prefix_id, -account_id -) -SELECT -'{{ prefix_id }}', -'{{ account_id }}' -RETURNING -errors, -messages, -result, -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: validate - props: - - name: prefix_id - value: "{{ prefix_id }}" - description: Required parameter for the validate resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the validate resource. -`} - - - diff --git a/stackql_cloudflare/website/docs/services/addressing/zones/index.md b/stackql_cloudflare/website/docs/services/addressing/zones/index.md deleted file mode 100644 index f24ae39d4df..00000000000 --- a/stackql_cloudflare/website/docs/services/addressing/zones/index.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: zones -hide_title: false -hide_table_of_contents: false -keywords: - - zones - - addressing - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a zones resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
zone_id, address_map_id, account_idAdd a zone as a member of a particular address map.
zone_id, address_map_id, account_idRemove a zone as a member of a particular address map.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
stringThe Cloudflare zone ID.
- -## `REPLACE` examples - - - - -Add a zone as a member of a particular address map. - -```sql -REPLACE cloudflare.addressing.zones -SET --- No updatable properties -WHERE -zone_id = '{{ zone_id }}' --required -AND address_map_id = '{{ address_map_id }}' --required -AND account_id = '{{ account_id }}' --required -RETURNING -errors, -messages, -result_info, -success; -``` - - - - -## `DELETE` examples - - - - -Remove a zone as a member of a particular address map. - -```sql -DELETE FROM cloudflare.addressing.zones -WHERE zone_id = '{{ zone_id }}' --required -AND address_map_id = '{{ address_map_id }}' --required -AND account_id = '{{ account_id }}' --required -; -``` - - diff --git a/stackql_cloudflare/website/docs/services/ai/ai_search/index.md b/stackql_cloudflare/website/docs/services/ai/ai_search/index.md index d0990b7f42e..b023c22080d 100644 --- a/stackql_cloudflare/website/docs/services/ai/ai_search/index.md +++ b/stackql_cloudflare/website/docs/services/ai/ai_search/index.md @@ -32,8 +32,39 @@ Creates, updates, deletes, gets or lists an ai_search resource. The following fields are returned by `SELECT` queries: -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + + +Returns the log details + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
boolean
+ + ## Methods @@ -52,8 +83,8 @@ The following methods are available for this resource: - - id, account_id, query + + id, account_id @@ -86,97 +117,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# -## `INSERT` examples +## `SELECT` examples -No description available. +Returns the log details ```sql -INSERT INTO cloudflare.ai.ai_search ( -filters, -max_num_results, -model, -query, -ranking_options, -reranking, -rewrite_query, -stream, -system_prompt, -id, -account_id -) -SELECT -'{{ filters }}', -{{ max_num_results }}, -'{{ model }}', -'{{ query }}' /* required */, -'{{ ranking_options }}', -'{{ reranking }}', -{{ rewrite_query }}, -{{ stream }}, -'{{ system_prompt }}', -'{{ id }}', -'{{ account_id }}' -RETURNING +SELECT result, success +FROM cloudflare.ai.ai_search +WHERE id = '{{ id }}' -- required +AND account_id = '{{ account_id }}' -- required ; ``` - - - -{`# Description fields are for documentation purposes -- name: ai_search - props: - - name: id - value: "{{ id }}" - description: Required parameter for the ai_search resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the ai_search resource. - - name: filters - value: - key: "{{ key }}" - type: "{{ type }}" - value: "{{ value }}" - filters: - - key: "{{ key }}" - type: "{{ type }}" - value: "{{ value }}" - - name: max_num_results - value: {{ max_num_results }} - default: 10 - - name: model - value: "{{ model }}" - valid_values: ['@cf/meta/llama-3.3-70b-instruct-fp8-fast', '@cf/meta/llama-3.1-8b-instruct-fast', '@cf/meta/llama-3.1-8b-instruct-fp8', '@cf/meta/llama-4-scout-17b-16e-instruct', '@cf/qwen/qwen3-30b-a3b-fp8', '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b', '@cf/moonshotai/kimi-k2-instruct', 'anthropic/claude-3-7-sonnet', 'anthropic/claude-sonnet-4', 'anthropic/claude-opus-4', 'anthropic/claude-3-5-haiku', 'cerebras/qwen-3-235b-a22b-instruct', 'cerebras/qwen-3-235b-a22b-thinking', 'cerebras/llama-3.3-70b', 'cerebras/llama-4-maverick-17b-128e-instruct', 'cerebras/llama-4-scout-17b-16e-instruct', 'cerebras/gpt-oss-120b', 'google-ai-studio/gemini-2.5-flash', 'google-ai-studio/gemini-2.5-pro', 'grok/grok-4', 'groq/llama-3.3-70b-versatile', 'groq/llama-3.1-8b-instant', 'openai/gpt-5', 'openai/gpt-5-mini', 'openai/gpt-5-nano'] - - name: query - value: "{{ query }}" - - name: ranking_options - value: - ranker: "{{ ranker }}" - score_threshold: {{ score_threshold }} - default: [object Object] - - name: reranking - value: - enabled: {{ enabled }} - model: "{{ model }}" - - name: rewrite_query - value: {{ rewrite_query }} - default: false - - name: stream - value: {{ stream }} - default: false - - name: system_prompt - value: "{{ system_prompt }}" -`} - diff --git a/stackql_cloudflare/website/docs/services/ai/assets/index.md b/stackql_cloudflare/website/docs/services/ai/assets/index.md deleted file mode 100644 index d35fa256eab..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/assets/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: assets -hide_title: false -hide_table_of_contents: false -keywords: - - assets - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an assets resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, finetune_id, file_name, fileUploads training data assets for a Workers AI fine-tuning job.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
- -## `INSERT` examples - - - - -Uploads training data assets for a Workers AI fine-tuning job. - -```sql -INSERT INTO cloudflare.ai.assets ( -file, -file_name, -account_id, -finetune_id -) -SELECT -'{{ file }}' /* required */, -'{{ file_name }}' /* required */, -'{{ account_id }}', -'{{ finetune_id }}' -RETURNING -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: assets - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the assets resource. - - name: finetune_id - value: "{{ finetune_id }}" - description: Required parameter for the assets resource. - - name: file - value: "{{ file }}" - description: | - File to upload - - name: file_name - value: "{{ file_name }}" - description: | - Name of the file (adapter_config.json or adapter_model.safetensors) -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/aura_1/index.md b/stackql_cloudflare/website/docs/services/ai/aura_1/index.md deleted file mode 100644 index 076a9cc3657..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/aura_1/index.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: aura_1 -hide_title: false -hide_table_of_contents: false -keywords: - - aura_1 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an aura_1 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/deepgram/aura-1 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepgram/aura-1 model. - -```sql -INSERT INTO cloudflare.ai.aura_1 ( -bit_rate, -container, -encoding, -sample_rate, -speaker, -text, -account_id, -queueRequest, -tags -) -SELECT -{{ bit_rate }}, -'{{ container }}', -'{{ encoding }}', -{{ sample_rate }}, -'{{ speaker }}', -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: aura_1 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the aura_1 resource. - - name: bit_rate - value: {{ bit_rate }} - description: | - The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. - - name: container - value: "{{ container }}" - description: | - Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. - valid_values: ['none', 'wav', 'ogg'] - - name: encoding - value: "{{ encoding }}" - description: | - Encoding of the output audio. - valid_values: ['linear16', 'flac', 'mulaw', 'alaw', 'mp3', 'opus', 'aac'] - - name: sample_rate - value: {{ sample_rate }} - description: | - Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable - - name: speaker - value: "{{ speaker }}" - description: | - Speaker used to produce the audio. - valid_values: ['angus', 'asteria', 'arcas', 'orion', 'orpheus', 'athena', 'luna', 'zeus', 'perseus', 'helios', 'hera', 'stella'] - default: angus - - name: text - value: "{{ text }}" - description: | - The text content to be converted to speech - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/aura_2_en/index.md b/stackql_cloudflare/website/docs/services/ai/aura_2_en/index.md deleted file mode 100644 index c83ea8f2076..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/aura_2_en/index.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: aura_2_en -hide_title: false -hide_table_of_contents: false -keywords: - - aura_2_en - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an aura_2_en resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/deepgram/aura-2-en model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepgram/aura-2-en model. - -```sql -INSERT INTO cloudflare.ai.aura_2_en ( -bit_rate, -container, -encoding, -sample_rate, -speaker, -text, -account_id, -queueRequest, -tags -) -SELECT -{{ bit_rate }}, -'{{ container }}', -'{{ encoding }}', -{{ sample_rate }}, -'{{ speaker }}', -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: aura_2_en - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the aura_2_en resource. - - name: bit_rate - value: {{ bit_rate }} - description: | - The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. - - name: container - value: "{{ container }}" - description: | - Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. - valid_values: ['none', 'wav', 'ogg'] - - name: encoding - value: "{{ encoding }}" - description: | - Encoding of the output audio. - valid_values: ['linear16', 'flac', 'mulaw', 'alaw', 'mp3', 'opus', 'aac'] - - name: sample_rate - value: {{ sample_rate }} - description: | - Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable - - name: speaker - value: "{{ speaker }}" - description: | - Speaker used to produce the audio. - valid_values: ['amalthea', 'andromeda', 'apollo', 'arcas', 'aries', 'asteria', 'athena', 'atlas', 'aurora', 'callista', 'cora', 'cordelia', 'delia', 'draco', 'electra', 'harmonia', 'helena', 'hera', 'hermes', 'hyperion', 'iris', 'janus', 'juno', 'jupiter', 'luna', 'mars', 'minerva', 'neptune', 'odysseus', 'ophelia', 'orion', 'orpheus', 'pandora', 'phoebe', 'pluto', 'saturn', 'thalia', 'theia', 'vesta', 'zeus'] - default: luna - - name: text - value: "{{ text }}" - description: | - The text content to be converted to speech - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/aura_2_es/index.md b/stackql_cloudflare/website/docs/services/ai/aura_2_es/index.md deleted file mode 100644 index 9efe2cd79d3..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/aura_2_es/index.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: aura_2_es -hide_title: false -hide_table_of_contents: false -keywords: - - aura_2_es - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an aura_2_es resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/deepgram/aura-2-es model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepgram/aura-2-es model. - -```sql -INSERT INTO cloudflare.ai.aura_2_es ( -bit_rate, -container, -encoding, -sample_rate, -speaker, -text, -account_id, -queueRequest, -tags -) -SELECT -{{ bit_rate }}, -'{{ container }}', -'{{ encoding }}', -{{ sample_rate }}, -'{{ speaker }}', -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: aura_2_es - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the aura_2_es resource. - - name: bit_rate - value: {{ bit_rate }} - description: | - The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. - - name: container - value: "{{ container }}" - description: | - Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. - valid_values: ['none', 'wav', 'ogg'] - - name: encoding - value: "{{ encoding }}" - description: | - Encoding of the output audio. - valid_values: ['linear16', 'flac', 'mulaw', 'alaw', 'mp3', 'opus', 'aac'] - - name: sample_rate - value: {{ sample_rate }} - description: | - Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable - - name: speaker - value: "{{ speaker }}" - description: | - Speaker used to produce the audio. - valid_values: ['sirio', 'nestor', 'carina', 'celeste', 'alvaro', 'diana', 'aquila', 'selena', 'estrella', 'javier'] - default: aquila - - name: text - value: "{{ text }}" - description: | - The text content to be converted to speech - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/authors/index.md b/stackql_cloudflare/website/docs/services/ai/authors/index.md index 25d22d49ec9..80a82395551 100644 --- a/stackql_cloudflare/website/docs/services/ai/authors/index.md +++ b/stackql_cloudflare/website/docs/services/ai/authors/index.md @@ -51,6 +51,11 @@ Returns a list of authors + + + string + + @@ -116,7 +121,7 @@ Searches Workers AI models by author or organization name. ```sql SELECT -* +author FROM cloudflare.ai.authors WHERE account_id = '{{ account_id }}' -- required ; diff --git a/stackql_cloudflare/website/docs/services/ai/bart_large_cnn/index.md b/stackql_cloudflare/website/docs/services/ai/bart_large_cnn/index.md deleted file mode 100644 index 599beb002b9..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/bart_large_cnn/index.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: bart_large_cnn -hide_title: false -hide_table_of_contents: false -keywords: - - bart_large_cnn - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a bart_large_cnn resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, input_textqueueRequest, tagsRuns inference on the @cf/facebook/bart-large-cnn model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/facebook/bart-large-cnn model. - -```sql -INSERT INTO cloudflare.ai.bart_large_cnn ( -input_text, -max_length, -account_id, -queueRequest, -tags -) -SELECT -'{{ input_text }}' /* required */, -{{ max_length }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: bart_large_cnn - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the bart_large_cnn resource. - - name: input_text - value: "{{ input_text }}" - description: | - The text that you want the model to summarize - - name: max_length - value: {{ max_length }} - description: | - The maximum length of the generated summary in tokens - default: 1024 - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/bge_base_en_v1_5/index.md b/stackql_cloudflare/website/docs/services/ai/bge_base_en_v1_5/index.md deleted file mode 100644 index 0e14825907d..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/bge_base_en_v1_5/index.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: bge_base_en_v1_5 -hide_title: false -hide_table_of_contents: false -keywords: - - bge_base_en_v1_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a bge_base_en_v1_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/bge-base-en-v1.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/bge-base-en-v1.5 model. - -```sql -INSERT INTO cloudflare.ai.bge_base_en_v1_5 ( -pooling, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ pooling }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: bge_base_en_v1_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the bge_base_en_v1_5 resource. - - name: pooling - value: "{{ pooling }}" - description: | - The pooling method used in the embedding process. \`cls\` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is \`mean\` in order for this to not be a breaking change, but we highly suggest using the new \`cls\` pooling for better accuracy. - valid_values: ['mean', 'cls'] - default: mean - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - pooling: "{{ pooling }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/bge_large_en_v1_5/index.md b/stackql_cloudflare/website/docs/services/ai/bge_large_en_v1_5/index.md deleted file mode 100644 index 4d8b45fa91e..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/bge_large_en_v1_5/index.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: bge_large_en_v1_5 -hide_title: false -hide_table_of_contents: false -keywords: - - bge_large_en_v1_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a bge_large_en_v1_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/bge-large-en-v1.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/bge-large-en-v1.5 model. - -```sql -INSERT INTO cloudflare.ai.bge_large_en_v1_5 ( -pooling, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ pooling }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: bge_large_en_v1_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the bge_large_en_v1_5 resource. - - name: pooling - value: "{{ pooling }}" - description: | - The pooling method used in the embedding process. \`cls\` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is \`mean\` in order for this to not be a breaking change, but we highly suggest using the new \`cls\` pooling for better accuracy. - valid_values: ['mean', 'cls'] - default: mean - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - pooling: "{{ pooling }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/bge_m3/index.md b/stackql_cloudflare/website/docs/services/ai/bge_m3/index.md deleted file mode 100644 index 435c7e4c902..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/bge_m3/index.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: bge_m3 -hide_title: false -hide_table_of_contents: false -keywords: - - bge_m3 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a bge_m3 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/bge-m3 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/bge-m3 model. - -```sql -INSERT INTO cloudflare.ai.bge_m3 ( -contexts, -query, -truncate_inputs, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ contexts }}', -'{{ query }}', -{{ truncate_inputs }}, -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: bge_m3 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the bge_m3 resource. - - name: contexts - description: | - List of provided contexts. Note that the index in this array is important, as the response will refer to it. - value: - - text: "{{ text }}" - - name: query - value: "{{ query }}" - description: | - A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts - - name: truncate_inputs - value: {{ truncate_inputs }} - description: | - When provided with too long context should the model error out or truncate the context to fit? - default: false - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - contexts: "{{ contexts }}" - query: "{{ query }}" - truncate_inputs: {{ truncate_inputs }} - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/bge_reranker_base/index.md b/stackql_cloudflare/website/docs/services/ai/bge_reranker_base/index.md deleted file mode 100644 index 88a71755265..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/bge_reranker_base/index.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: bge_reranker_base -hide_title: false -hide_table_of_contents: false -keywords: - - bge_reranker_base - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a bge_reranker_base resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, query, contextsqueueRequest, tagsRuns inference on the @cf/baai/bge-reranker-base model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/bge-reranker-base model. - -```sql -INSERT INTO cloudflare.ai.bge_reranker_base ( -contexts, -query, -top_k, -account_id, -queueRequest, -tags -) -SELECT -'{{ contexts }}' /* required */, -'{{ query }}' /* required */, -{{ top_k }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: bge_reranker_base - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the bge_reranker_base resource. - - name: contexts - description: | - List of provided contexts. Note that the index in this array is important, as the response will refer to it. - value: - - text: "{{ text }}" - - name: query - value: "{{ query }}" - description: | - A query you wish to perform against the provided contexts. - - name: top_k - value: {{ top_k }} - description: | - Number of returned results starting with the best score. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/bge_small_en_v1_5/index.md b/stackql_cloudflare/website/docs/services/ai/bge_small_en_v1_5/index.md deleted file mode 100644 index 8d66c26f794..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/bge_small_en_v1_5/index.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: bge_small_en_v1_5 -hide_title: false -hide_table_of_contents: false -keywords: - - bge_small_en_v1_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a bge_small_en_v1_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/bge-small-en-v1.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/bge-small-en-v1.5 model. - -```sql -INSERT INTO cloudflare.ai.bge_small_en_v1_5 ( -pooling, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ pooling }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: bge_small_en_v1_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the bge_small_en_v1_5 resource. - - name: pooling - value: "{{ pooling }}" - description: | - The pooling method used in the embedding process. \`cls\` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is \`mean\` in order for this to not be a breaking change, but we highly suggest using the new \`cls\` pooling for better accuracy. - valid_values: ['mean', 'cls'] - default: mean - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - pooling: "{{ pooling }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/deepseek_coder_6_7b_base_awq/index.md b/stackql_cloudflare/website/docs/services/ai/deepseek_coder_6_7b_base_awq/index.md deleted file mode 100644 index c645f80d1c6..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/deepseek_coder_6_7b_base_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: deepseek_coder_6_7b_base_awq -hide_title: false -hide_table_of_contents: false -keywords: - - deepseek_coder_6_7b_base_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a deepseek_coder_6_7b_base_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/deepseek-coder-6.7b-base-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/deepseek-coder-6.7b-base-awq model. - -```sql -INSERT INTO cloudflare.ai.deepseek_coder_6_7b_base_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: deepseek_coder_6_7b_base_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the deepseek_coder_6_7b_base_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/deepseek_coder_6_7b_instruct_awq/index.md b/stackql_cloudflare/website/docs/services/ai/deepseek_coder_6_7b_instruct_awq/index.md deleted file mode 100644 index 65a9ff0fe7a..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/deepseek_coder_6_7b_instruct_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: deepseek_coder_6_7b_instruct_awq -hide_title: false -hide_table_of_contents: false -keywords: - - deepseek_coder_6_7b_instruct_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a deepseek_coder_6_7b_instruct_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/deepseek-coder-6.7b-instruct-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/deepseek-coder-6.7b-instruct-awq model. - -```sql -INSERT INTO cloudflare.ai.deepseek_coder_6_7b_instruct_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: deepseek_coder_6_7b_instruct_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the deepseek_coder_6_7b_instruct_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/deepseek_math_7b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/deepseek_math_7b_instruct/index.md deleted file mode 100644 index eee6cfa3061..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/deepseek_math_7b_instruct/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: deepseek_math_7b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - deepseek_math_7b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a deepseek_math_7b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/deepseek-ai/deepseek-math-7b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepseek-ai/deepseek-math-7b-instruct model. - -```sql -INSERT INTO cloudflare.ai.deepseek_math_7b_instruct ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: deepseek_math_7b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the deepseek_math_7b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/deepseek_r1_distill_qwen_32b/index.md b/stackql_cloudflare/website/docs/services/ai/deepseek_r1_distill_qwen_32b/index.md deleted file mode 100644 index 231574aee23..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/deepseek_r1_distill_qwen_32b/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: deepseek_r1_distill_qwen_32b -hide_title: false -hide_table_of_contents: false -keywords: - - deepseek_r1_distill_qwen_32b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a deepseek_r1_distill_qwen_32b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/deepseek-ai/deepseek-r1-distill-qwen-32b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepseek-ai/deepseek-r1-distill-qwen-32b model. - -```sql -INSERT INTO cloudflare.ai.deepseek_r1_distill_qwen_32b ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: deepseek_r1_distill_qwen_32b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the deepseek_r1_distill_qwen_32b resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/discolm_german_7b_v1_awq/index.md b/stackql_cloudflare/website/docs/services/ai/discolm_german_7b_v1_awq/index.md deleted file mode 100644 index db5c629749e..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/discolm_german_7b_v1_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: discolm_german_7b_v1_awq -hide_title: false -hide_table_of_contents: false -keywords: - - discolm_german_7b_v1_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a discolm_german_7b_v1_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/thebloke/discolm-german-7b-v1-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/thebloke/discolm-german-7b-v1-awq model. - -```sql -INSERT INTO cloudflare.ai.discolm_german_7b_v1_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: discolm_german_7b_v1_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the discolm_german_7b_v1_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/distilbert_sst_2_int8/index.md b/stackql_cloudflare/website/docs/services/ai/distilbert_sst_2_int8/index.md deleted file mode 100644 index 38ca3473a1d..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/distilbert_sst_2_int8/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: distilbert_sst_2_int8 -hide_title: false -hide_table_of_contents: false -keywords: - - distilbert_sst_2_int8 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a distilbert_sst_2_int8 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/huggingface/distilbert-sst-2-int8 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/huggingface/distilbert-sst-2-int8 model. - -```sql -INSERT INTO cloudflare.ai.distilbert_sst_2_int8 ( -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: distilbert_sst_2_int8 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the distilbert_sst_2_int8 resource. - - name: text - value: "{{ text }}" - description: | - The text that you want to classify - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/dreamshaper_8_lcm/index.md b/stackql_cloudflare/website/docs/services/ai/dreamshaper_8_lcm/index.md deleted file mode 100644 index d728ed497c0..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/dreamshaper_8_lcm/index.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: dreamshaper_8_lcm -hide_title: false -hide_table_of_contents: false -keywords: - - dreamshaper_8_lcm - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a dreamshaper_8_lcm resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/lykon/dreamshaper-8-lcm model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/lykon/dreamshaper-8-lcm model. - -```sql -INSERT INTO cloudflare.ai.dreamshaper_8_lcm ( -guidance, -height, -image, -image_b64, -mask, -negative_prompt, -num_steps, -prompt, -seed, -strength, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -'{{ image }}', -'{{ image_b64 }}', -'{{ mask }}', -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ strength }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: dreamshaper_8_lcm - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the dreamshaper_8_lcm resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 7.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - - name: image - value: - - {{ image }} - description: | - For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - - name: image_b64 - value: "{{ image_b64 }}" - description: | - For use with img2img tasks. A base64-encoded string of the input image - - name: mask - value: - - {{ mask }} - description: | - An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Text describing elements to avoid in the generated image - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 20 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: strength - value: {{ strength }} - description: | - A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - default: 1 - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/embeddinggemma_300m/index.md b/stackql_cloudflare/website/docs/services/ai/embeddinggemma_300m/index.md deleted file mode 100644 index 0d6a605d827..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/embeddinggemma_300m/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: embeddinggemma_300m -hide_title: false -hide_table_of_contents: false -keywords: - - embeddinggemma_300m - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an embeddinggemma_300m resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/google/embeddinggemma-300m model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/google/embeddinggemma-300m model. - -```sql -INSERT INTO cloudflare.ai.embeddinggemma_300m ( -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: embeddinggemma_300m - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the embeddinggemma_300m resource. - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/falcon_7b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/falcon_7b_instruct/index.md deleted file mode 100644 index efc5fb8de40..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/falcon_7b_instruct/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: falcon_7b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - falcon_7b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a falcon_7b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/tiiuae/falcon-7b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/tiiuae/falcon-7b-instruct model. - -```sql -INSERT INTO cloudflare.ai.falcon_7b_instruct ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: falcon_7b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the falcon_7b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/finetunes/index.md b/stackql_cloudflare/website/docs/services/ai/finetunes/index.md index 9f87a71b523..363121c9471 100644 --- a/stackql_cloudflare/website/docs/services/ai/finetunes/index.md +++ b/stackql_cloudflare/website/docs/services/ai/finetunes/index.md @@ -115,6 +115,13 @@ The following methods are available for this resource: Creates a new fine-tuning job for a Workers AI model using custom training data. + + + + account_id, finetune_id, file_name, file + + Uploads training data assets for a Workers AI fine-tuning job. + @@ -136,6 +143,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The Cloudflare account ID. + + + string + + @@ -221,3 +233,30 @@ success + + +## Lifecycle Methods + + + + +Uploads training data assets for a Workers AI fine-tuning job. + +```sql +EXEC cloudflare.ai.finetunes.upload_asset +@account_id='{{ account_id }}' --required, +@finetune_id='{{ finetune_id }}' --required +@@json= +'{ +"file": "{{ file }}", +"file_name": "{{ file_name }}" +}' +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/flux/index.md b/stackql_cloudflare/website/docs/services/ai/flux/index.md deleted file mode 100644 index 071d3cf3da1..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/flux/index.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: flux -hide_title: false -hide_table_of_contents: false -keywords: - - flux - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a flux resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, sample_rate, encodingqueueRequest, tagsRuns inference on the @cf/deepgram/flux model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepgram/flux model. - -```sql -INSERT INTO cloudflare.ai.flux ( -eager_eot_threshold, -encoding, -eot_threshold, -eot_timeout_ms, -keyterm, -mip_opt_out, -sample_rate, -tag, -account_id, -queueRequest, -tags -) -SELECT -'{{ eager_eot_threshold }}', -'{{ encoding }}' /* required */, -'{{ eot_threshold }}', -'{{ eot_timeout_ms }}', -'{{ keyterm }}', -'{{ mip_opt_out }}', -'{{ sample_rate }}' /* required */, -'{{ tag }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: flux - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the flux resource. - - name: eager_eot_threshold - value: "{{ eager_eot_threshold }}" - description: | - End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9. - - name: encoding - value: "{{ encoding }}" - description: | - Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM. - valid_values: ['linear16'] - - name: eot_threshold - value: "{{ eot_threshold }}" - description: | - End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9. - default: 0.7 - - name: eot_timeout_ms - value: "{{ eot_timeout_ms }}" - description: | - A turn will be finished when this much time has passed after speech, regardless of EOT confidence. - default: 5000 - - name: keyterm - value: "{{ keyterm }}" - description: | - Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms. - - name: mip_opt_out - value: "{{ mip_opt_out }}" - description: | - Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip - valid_values: ['true', 'false'] - default: false - - name: sample_rate - value: "{{ sample_rate }}" - description: | - Sample rate of the audio stream in Hz. - - name: tag - value: "{{ tag }}" - description: | - Label your requests for the purpose of identification during usage reporting - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/flux_1_schnell/index.md b/stackql_cloudflare/website/docs/services/ai/flux_1_schnell/index.md deleted file mode 100644 index 03f9d98a18c..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/flux_1_schnell/index.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: flux_1_schnell -hide_title: false -hide_table_of_contents: false -keywords: - - flux_1_schnell - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a flux_1_schnell resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/black-forest-labs/flux-1-schnell model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/black-forest-labs/flux-1-schnell model. - -```sql -INSERT INTO cloudflare.ai.flux_1_schnell ( -prompt, -steps, -account_id, -queueRequest, -tags -) -SELECT -'{{ prompt }}' /* required */, -{{ steps }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: flux_1_schnell - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the flux_1_schnell resource. - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate. - - name: steps - value: {{ steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer. - default: 4 - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/flux_2_dev/index.md b/stackql_cloudflare/website/docs/services/ai/flux_2_dev/index.md deleted file mode 100644 index 18ee688c45a..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/flux_2_dev/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: flux_2_dev -hide_title: false -hide_table_of_contents: false -keywords: - - flux_2_dev - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a flux_2_dev resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, multipartqueueRequest, tagsRuns inference on the @cf/black-forest-labs/flux-2-dev model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/black-forest-labs/flux-2-dev model. - -```sql -INSERT INTO cloudflare.ai.flux_2_dev ( -multipart, -account_id, -queueRequest, -tags -) -SELECT -'{{ multipart }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: flux_2_dev - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the flux_2_dev resource. - - name: multipart - value: - body: "{{ body }}" - contentType: "{{ contentType }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/flux_2_klein_4b/index.md b/stackql_cloudflare/website/docs/services/ai/flux_2_klein_4b/index.md deleted file mode 100644 index ea96201a880..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/flux_2_klein_4b/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: flux_2_klein_4b -hide_title: false -hide_table_of_contents: false -keywords: - - flux_2_klein_4b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a flux_2_klein_4b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, multipartqueueRequest, tagsRuns inference on the @cf/black-forest-labs/flux-2-klein-4b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/black-forest-labs/flux-2-klein-4b model. - -```sql -INSERT INTO cloudflare.ai.flux_2_klein_4b ( -multipart, -account_id, -queueRequest, -tags -) -SELECT -'{{ multipart }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: flux_2_klein_4b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the flux_2_klein_4b resource. - - name: multipart - value: - body: "{{ body }}" - contentType: "{{ contentType }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/flux_2_klein_9b/index.md b/stackql_cloudflare/website/docs/services/ai/flux_2_klein_9b/index.md deleted file mode 100644 index f7c4aff1646..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/flux_2_klein_9b/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: flux_2_klein_9b -hide_title: false -hide_table_of_contents: false -keywords: - - flux_2_klein_9b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a flux_2_klein_9b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, multipartqueueRequest, tagsRuns inference on the @cf/black-forest-labs/flux-2-klein-9b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/black-forest-labs/flux-2-klein-9b model. - -```sql -INSERT INTO cloudflare.ai.flux_2_klein_9b ( -multipart, -account_id, -queueRequest, -tags -) -SELECT -'{{ multipart }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: flux_2_klein_9b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the flux_2_klein_9b resource. - - name: multipart - value: - body: "{{ body }}" - contentType: "{{ contentType }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gemma_2b_it_lora/index.md b/stackql_cloudflare/website/docs/services/ai/gemma_2b_it_lora/index.md deleted file mode 100644 index 8055a575f9b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gemma_2b_it_lora/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: gemma_2b_it_lora -hide_title: false -hide_table_of_contents: false -keywords: - - gemma_2b_it_lora - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gemma_2b_it_lora resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/google/gemma-2b-it-lora model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/google/gemma-2b-it-lora model. - -```sql -INSERT INTO cloudflare.ai.gemma_2b_it_lora ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gemma_2b_it_lora - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gemma_2b_it_lora resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gemma_3_12b_it/index.md b/stackql_cloudflare/website/docs/services/ai/gemma_3_12b_it/index.md deleted file mode 100644 index 17d9dc1e2ce..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gemma_3_12b_it/index.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -title: gemma_3_12b_it -hide_title: false -hide_table_of_contents: false -keywords: - - gemma_3_12b_it - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gemma_3_12b_it resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/google/gemma-3-12b-it model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/google/gemma-3-12b-it model. - -```sql -INSERT INTO cloudflare.ai.gemma_3_12b_it ( -frequency_penalty, -guided_json, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ guided_json }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gemma_3_12b_it - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gemma_3_12b_it resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: guided_json - value: "{{ guided_json }}" - description: | - JSON schema that should be fufilled for the response. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gemma_7b_it/index.md b/stackql_cloudflare/website/docs/services/ai/gemma_7b_it/index.md deleted file mode 100644 index d43f7eccc0b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gemma_7b_it/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: gemma_7b_it -hide_title: false -hide_table_of_contents: false -keywords: - - gemma_7b_it - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gemma_7b_it resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/google/gemma-7b-it model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/google/gemma-7b-it model. - -```sql -INSERT INTO cloudflare.ai.gemma_7b_it ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gemma_7b_it - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gemma_7b_it resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gemma_7b_it_lora/index.md b/stackql_cloudflare/website/docs/services/ai/gemma_7b_it_lora/index.md deleted file mode 100644 index 98750dd29c0..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gemma_7b_it_lora/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: gemma_7b_it_lora -hide_title: false -hide_table_of_contents: false -keywords: - - gemma_7b_it_lora - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gemma_7b_it_lora resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/google/gemma-7b-it-lora model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/google/gemma-7b-it-lora model. - -```sql -INSERT INTO cloudflare.ai.gemma_7b_it_lora ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gemma_7b_it_lora - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gemma_7b_it_lora resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gemma_sea_lion_v4_27b_it/index.md b/stackql_cloudflare/website/docs/services/ai/gemma_sea_lion_v4_27b_it/index.md deleted file mode 100644 index b6a2f8dd216..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gemma_sea_lion_v4_27b_it/index.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -title: gemma_sea_lion_v4_27b_it -hide_title: false -hide_table_of_contents: false -keywords: - - gemma_sea_lion_v4_27b_it - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gemma_sea_lion_v4_27b_it resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/aisingapore/gemma-sea-lion-v4-27b-it model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/aisingapore/gemma-sea-lion-v4-27b-it model. - -```sql -INSERT INTO cloudflare.ai.gemma_sea_lion_v4_27b_it ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -requests, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gemma_sea_lion_v4_27b_it - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gemma_sea_lion_v4_27b_it resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 2000 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: requests - value: - - frequency_penalty: {{ frequency_penalty }} - lora: "{{ lora }}" - max_tokens: {{ max_tokens }} - presence_penalty: {{ presence_penalty }} - prompt: "{{ prompt }}" - raw: {{ raw }} - repetition_penalty: {{ repetition_penalty }} - response_format: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - seed: {{ seed }} - stream: {{ stream }} - temperature: {{ temperature }} - top_k: {{ top_k }} - top_p: {{ top_p }} - functions: "{{ functions }}" - messages: "{{ messages }}" - tools: "{{ tools }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/glm_4_7_flash/index.md b/stackql_cloudflare/website/docs/services/ai/glm_4_7_flash/index.md deleted file mode 100644 index 40bb4a5c12d..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/glm_4_7_flash/index.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -title: glm_4_7_flash -hide_title: false -hide_table_of_contents: false -keywords: - - glm_4_7_flash - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a glm_4_7_flash resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/zai-org/glm-4.7-flash model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/zai-org/glm-4.7-flash model. - -```sql -INSERT INTO cloudflare.ai.glm_4_7_flash ( -audio, -chat_template_kwargs, -frequency_penalty, -function_call, -functions, -logit_bias, -logprobs, -max_completion_tokens, -max_tokens, -metadata, -modalities, -model, -n, -parallel_tool_calls, -prediction, -presence_penalty, -prompt, -reasoning_effort, -response_format, -seed, -service_tier, -stop, -store, -stream, -stream_options, -temperature, -tool_choice, -tools, -top_logprobs, -top_p, -user, -web_search_options, -messages, -account_id, -queueRequest, -tags -) -SELECT -'{{ audio }}', -'{{ chat_template_kwargs }}', -{{ frequency_penalty }}, -'{{ function_call }}', -'{{ functions }}', -'{{ logit_bias }}', -{{ logprobs }}, -{{ max_completion_tokens }}, -{{ max_tokens }}, -'{{ metadata }}', -'{{ modalities }}', -'{{ model }}', -{{ n }}, -{{ parallel_tool_calls }}, -'{{ prediction }}', -{{ presence_penalty }}, -'{{ prompt }}', -'{{ reasoning_effort }}', -'{{ response_format }}', -{{ seed }}, -'{{ service_tier }}', -'{{ stop }}', -{{ store }}, -{{ stream }}, -'{{ stream_options }}', -{{ temperature }}, -'{{ tool_choice }}', -'{{ tools }}', -{{ top_logprobs }}, -{{ top_p }}, -'{{ user }}', -'{{ web_search_options }}', -'{{ messages }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: glm_4_7_flash - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the glm_4_7_flash resource. - - name: audio - description: | - Parameters for audio output. Required when modalities includes 'audio'. - value: - format: "{{ format }}" - voice: "{{ voice }}" - - name: chat_template_kwargs - value: - clear_thinking: {{ clear_thinking }} - enable_thinking: {{ enable_thinking }} - - name: frequency_penalty - value: {{ frequency_penalty }} - - name: function_call - value: "{{ function_call }}" - valid_values: ['none', 'auto'] - - name: functions - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: "{{ parameters }}" - strict: {{ strict }} - - name: logit_bias - value: "{{ logit_bias }}" - - name: logprobs - value: {{ logprobs }} - - name: max_completion_tokens - value: {{ max_completion_tokens }} - - name: max_tokens - value: {{ max_tokens }} - - name: metadata - value: "{{ metadata }}" - - name: modalities - value: - - "{{ modalities }}" - - name: model - value: "{{ model }}" - description: | - ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - - name: n - value: {{ n }} - - name: parallel_tool_calls - value: {{ parallel_tool_calls }} - description: | - Whether to enable parallel function calling during tool use. - default: true - - name: prediction - value: - content: "{{ content }}" - type: "{{ type }}" - - name: presence_penalty - value: {{ presence_penalty }} - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: reasoning_effort - value: "{{ reasoning_effort }}" - valid_values: ['low', 'medium', 'high'] - - name: response_format - description: | - Specifies the format the model must output. - value: - type: "{{ type }}" - json_schema: - description: "{{ description }}" - name: "{{ name }}" - schema: "{{ schema }}" - strict: {{ strict }} - - name: seed - value: {{ seed }} - - name: service_tier - value: "{{ service_tier }}" - valid_values: ['auto', 'default', 'flex', 'scale', 'priority'] - - name: stop - value: "{{ stop }}" - - name: store - value: {{ store }} - - name: stream - value: {{ stream }} - - name: stream_options - value: - include_obfuscation: {{ include_obfuscation }} - include_usage: {{ include_usage }} - - name: temperature - value: {{ temperature }} - - name: tool_choice - value: "{{ tool_choice }}" - description: | - Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - valid_values: ['none', 'auto', 'required'] - - name: tools - description: | - A list of tools the model may call. - value: - - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: "{{ parameters }}" - strict: {{ strict }} - type: "{{ type }}" - custom: - description: "{{ description }}" - format: - type: "{{ type }}" - grammar: - definition: "{{ definition }}" - syntax: "{{ syntax }}" - name: "{{ name }}" - - name: top_logprobs - value: {{ top_logprobs }} - - name: top_p - value: {{ top_p }} - - name: user - value: "{{ user }}" - description: | - A unique identifier representing your end-user, for abuse monitoring. - - name: web_search_options - description: | - Options for the web search tool (when using built-in web search). - value: - search_context_size: "{{ search_context_size }}" - user_location: - approximate: - city: "{{ city }}" - country: "{{ country }}" - region: "{{ region }}" - timezone: "{{ timezone }}" - type: "{{ type }}" - - name: messages - description: | - A list of messages comprising the conversation so far. - value: - - content: "{{ content }}" - name: "{{ name }}" - role: "{{ role }}" - audio: - id: "{{ id }}" - function_call: - arguments: "{{ arguments }}" - name: "{{ name }}" - refusal: "{{ refusal }}" - tool_calls: "{{ tool_calls }}" - tool_call_id: "{{ tool_call_id }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gpt_oss_120b/index.md b/stackql_cloudflare/website/docs/services/ai/gpt_oss_120b/index.md deleted file mode 100644 index abb383ce4fb..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gpt_oss_120b/index.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -title: gpt_oss_120b -hide_title: false -hide_table_of_contents: false -keywords: - - gpt_oss_120b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gpt_oss_120b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/openai/gpt-oss-120b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/openai/gpt-oss-120b model. - -```sql -INSERT INTO cloudflare.ai.gpt_oss_120b ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -input, -reasoning, -requests, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ input }}', -'{{ reasoning }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gpt_oss_120b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gpt_oss_120b resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: input - value: "{{ input }}" - description: | - Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types - - name: reasoning - value: - effort: "{{ effort }}" - summary: "{{ summary }}" - - name: requests - value: - - input: "{{ input }}" - reasoning: - effort: "{{ effort }}" - summary: "{{ summary }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/gpt_oss_20b/index.md b/stackql_cloudflare/website/docs/services/ai/gpt_oss_20b/index.md deleted file mode 100644 index 7b7b757915c..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/gpt_oss_20b/index.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -title: gpt_oss_20b -hide_title: false -hide_table_of_contents: false -keywords: - - gpt_oss_20b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a gpt_oss_20b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/openai/gpt-oss-20b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/openai/gpt-oss-20b model. - -```sql -INSERT INTO cloudflare.ai.gpt_oss_20b ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -input, -reasoning, -requests, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ input }}', -'{{ reasoning }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: gpt_oss_20b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the gpt_oss_20b resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: input - value: "{{ input }}" - description: | - Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types - - name: reasoning - value: - effort: "{{ effort }}" - summary: "{{ summary }}" - - name: requests - value: - - input: "{{ input }}" - reasoning: - effort: "{{ effort }}" - summary: "{{ summary }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/granite_4_0_h_micro/index.md b/stackql_cloudflare/website/docs/services/ai/granite_4_0_h_micro/index.md deleted file mode 100644 index a78c0b1f3e8..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/granite_4_0_h_micro/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: granite_4_0_h_micro -hide_title: false -hide_table_of_contents: false -keywords: - - granite_4_0_h_micro - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a granite_4_0_h_micro resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/ibm-granite/granite-4.0-h-micro model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/ibm-granite/granite-4.0-h-micro model. - -```sql -INSERT INTO cloudflare.ai.granite_4_0_h_micro ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: granite_4_0_h_micro - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the granite_4_0_h_micro resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/hermes_2_pro_mistral_7b/index.md b/stackql_cloudflare/website/docs/services/ai/hermes_2_pro_mistral_7b/index.md deleted file mode 100644 index 984d888485b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/hermes_2_pro_mistral_7b/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: hermes_2_pro_mistral_7b -hide_title: false -hide_table_of_contents: false -keywords: - - hermes_2_pro_mistral_7b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a hermes_2_pro_mistral_7b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/nousresearch/hermes-2-pro-mistral-7b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/nousresearch/hermes-2-pro-mistral-7b model. - -```sql -INSERT INTO cloudflare.ai.hermes_2_pro_mistral_7b ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: hermes_2_pro_mistral_7b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the hermes_2_pro_mistral_7b resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/index.md b/stackql_cloudflare/website/docs/services/ai/index.md index 2a1ff21d61c..17f51af11a7 100644 --- a/stackql_cloudflare/website/docs/services/ai/index.md +++ b/stackql_cloudflare/website/docs/services/ai/index.md @@ -18,7 +18,7 @@ ai service documentation. :::info[Service Summary] -total resources: __114__ +total resources: __23__ ::: @@ -26,120 +26,29 @@ total resources: __114__
ai_search
-assets
-aura_1
-aura_2_en
-aura_2_es
authors
-bart_large_cnn
-bge_base_en_v1_5
-bge_large_en_v1_5
-bge_m3
-bge_reranker_base
-bge_small_en_v1_5
-deepseek_coder_6_7b_base_awq
-deepseek_coder_6_7b_instruct_awq
-deepseek_math_7b_instruct
-deepseek_r1_distill_qwen_32b
-discolm_german_7b_v1_awq
-distilbert_sst_2_int8
-dreamshaper_8_lcm
-embeddinggemma_300m
-falcon_7b_instruct
files
finetunes
-flux
-flux_1_schnell
-flux_2_dev
-flux_2_klein_4b
-flux_2_klein_9b
-gemma_2b_it_lora
-gemma_3_12b_it
-gemma_7b_it
-gemma_7b_it_lora
-gemma_sea_lion_v4_27b_it
-glm_4_7_flash
-gpt_oss_120b
-gpt_oss_20b
-granite_4_0_h_micro
-hermes_2_pro_mistral_7b
-indictrans2_en_indic_1_b
jobs
-kimi_k2_5
-llama_2_13b_chat_awq
-llama_2_7b_chat_fp16
-llama_2_7b_chat_hf_lora
-llama_2_7b_chat_int8
-llama_3_1_70b_instruct_fp8_fast
-llama_3_1_8b_instruct_awq
-llama_3_1_8b_instruct_fp8
-llama_3_1_8b_instruct_fp8_fast
-llama_3_2_11b_vision_instruct
-llama_3_2_1b_instruct
-llama_3_2_3b_instruct
-llama_3_3_70b_instruct_fp8_fast
-llama_3_8b_instruct
-llama_3_8b_instruct_awq
-llama_4_scout_17b_16e_instruct
-llama_guard_3_8b -
-
logs
-lucid_origin
-m2m100_1_2b
-melotts
-mistral_7b_instruct_v0_1
-mistral_7b_instruct_v0_1_awq
-mistral_7b_instruct_v0_2
-mistral_7b_instruct_v0_2_lora
-mistral_small_3_1_24b_instruct
models
-nemotron_3_120b_a12b
-neural_chat_7b_v3_1_awq
-nonomni_bart_large_cnn
-nonomni_bge_base_en_v1_5
-nonomni_bge_large_en_v1_5
-nonomni_bge_m3
-nonomni_bge_small_en_v1_5
-nonomni_detr_resnet_50
-nonomni_distilbert_sst_2_int8
-nonomni_embeddinggemma_300m
-nonomni_indictrans2_en_indic_1b
-nonomni_resnet_50
-nova_3
-openchat_3_5_0106
-openhermes_2_5_mistral_7b_awq
-phi_2
-phoenix_1_0
-plamo_embedding_1b
public
-qwen1_5_0_5b_chat
-qwen1_5_1_8b_chat
-qwen1_5_14b_chat_awq
-qwen1_5_7b_chat_awq
-qwen2_5_coder_32b_instruct
-qwen3_30b_a3b_fp8
-qwen3_embedding_0_6b
-qwq_32b
-resnet_50
+reranking
run
schema
-search
-sqlcoder_7b_2
-stable_diffusion_v1_5_img2img
-stable_diffusion_v1_5_inpainting
-stable_diffusion_xl_base_1_0
-stable_diffusion_xl_lightning
-starling_lm_7b_beta
-sync
+search +
+
+speech_to_text
+summarization
tasks
-tinyllama_1_1b_chat_v1_0
+text_classification
+text_embeddings
+text_generation
+text_to_image
+text_to_speech
to_markdown
-tomarkdown
-una_cybertron_7b_v2_bf16
-whisper
-whisper_large_v3_turbo
-whisper_tiny_en
-zephyr_7b_beta_awq +to_markdown_supported
+translation
\ No newline at end of file diff --git a/stackql_cloudflare/website/docs/services/ai/indictrans2_en_indic_1_b/index.md b/stackql_cloudflare/website/docs/services/ai/indictrans2_en_indic_1_b/index.md deleted file mode 100644 index 103087d81ab..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/indictrans2_en_indic_1_b/index.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: indictrans2_en_indic_1_b -hide_title: false -hide_table_of_contents: false -keywords: - - indictrans2_en_indic_1_b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an indictrans2_en_indic_1_b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, text, target_languagequeueRequest, tagsRuns inference on the @cf/ai4bharat/indictrans2-en-indic-1B model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/ai4bharat/indictrans2-en-indic-1B model. - -```sql -INSERT INTO cloudflare.ai.indictrans2_en_indic_1_b ( -target_language, -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ target_language }}' /* required */, -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: indictrans2_en_indic_1_b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the indictrans2_en_indic_1_b resource. - - name: target_language - value: "{{ target_language }}" - description: | - Target langauge to translate to - valid_values: ['asm_Beng', 'awa_Deva', 'ben_Beng', 'bho_Deva', 'brx_Deva', 'doi_Deva', 'eng_Latn', 'gom_Deva', 'gon_Deva', 'guj_Gujr', 'hin_Deva', 'hne_Deva', 'kan_Knda', 'kas_Arab', 'kas_Deva', 'kha_Latn', 'lus_Latn', 'mag_Deva', 'mai_Deva', 'mal_Mlym', 'mar_Deva', 'mni_Beng', 'mni_Mtei', 'npi_Deva', 'ory_Orya', 'pan_Guru', 'san_Deva', 'sat_Olck', 'snd_Arab', 'snd_Deva', 'tam_Taml', 'tel_Telu', 'urd_Arab', 'unr_Deva'] - default: hin_Deva - - name: text - value: "{{ text }}" - description: | - Input text to translate. Can be a single string or a list of strings. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/jobs/index.md b/stackql_cloudflare/website/docs/services/ai/jobs/index.md index b56461e2a59..5636460e3d0 100644 --- a/stackql_cloudflare/website/docs/services/ai/jobs/index.md +++ b/stackql_cloudflare/website/docs/services/ai/jobs/index.md @@ -162,6 +162,13 @@ The following methods are available for this resource: page, per_page + + + + id, account_id + + + @@ -255,3 +262,25 @@ AND per_page = '{{ per_page }}' ``` + + +## Lifecycle Methods + + + + +Returns the autorag sync status + +```sql +EXEC cloudflare.ai.jobs.sync +@id='{{ id }}' --required, +@account_id='{{ account_id }}' --required +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/kimi_k2_5/index.md b/stackql_cloudflare/website/docs/services/ai/kimi_k2_5/index.md deleted file mode 100644 index 2d874a26eeb..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/kimi_k2_5/index.md +++ /dev/null @@ -1,403 +0,0 @@ ---- -title: kimi_k2_5 -hide_title: false -hide_table_of_contents: false -keywords: - - kimi_k2_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a kimi_k2_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/moonshotai/kimi-k2.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/moonshotai/kimi-k2.5 model. - -```sql -INSERT INTO cloudflare.ai.kimi_k2_5 ( -audio, -chat_template_kwargs, -frequency_penalty, -function_call, -functions, -logit_bias, -logprobs, -max_completion_tokens, -max_tokens, -metadata, -modalities, -model, -n, -parallel_tool_calls, -prediction, -presence_penalty, -prompt, -reasoning_effort, -response_format, -seed, -service_tier, -stop, -store, -stream, -stream_options, -temperature, -tool_choice, -tools, -top_logprobs, -top_p, -user, -web_search_options, -messages, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ audio }}', -'{{ chat_template_kwargs }}', -{{ frequency_penalty }}, -'{{ function_call }}', -'{{ functions }}', -'{{ logit_bias }}', -{{ logprobs }}, -{{ max_completion_tokens }}, -{{ max_tokens }}, -'{{ metadata }}', -'{{ modalities }}', -'{{ model }}', -{{ n }}, -{{ parallel_tool_calls }}, -'{{ prediction }}', -{{ presence_penalty }}, -'{{ prompt }}', -'{{ reasoning_effort }}', -'{{ response_format }}', -{{ seed }}, -'{{ service_tier }}', -'{{ stop }}', -{{ store }}, -{{ stream }}, -'{{ stream_options }}', -{{ temperature }}, -'{{ tool_choice }}', -'{{ tools }}', -{{ top_logprobs }}, -{{ top_p }}, -'{{ user }}', -'{{ web_search_options }}', -'{{ messages }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: kimi_k2_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the kimi_k2_5 resource. - - name: audio - description: | - Parameters for audio output. Required when modalities includes 'audio'. - value: - format: "{{ format }}" - voice: "{{ voice }}" - - name: chat_template_kwargs - value: - clear_thinking: {{ clear_thinking }} - enable_thinking: {{ enable_thinking }} - - name: frequency_penalty - value: {{ frequency_penalty }} - - name: function_call - value: "{{ function_call }}" - valid_values: ['none', 'auto'] - - name: functions - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: "{{ parameters }}" - strict: {{ strict }} - - name: logit_bias - value: "{{ logit_bias }}" - - name: logprobs - value: {{ logprobs }} - - name: max_completion_tokens - value: {{ max_completion_tokens }} - - name: max_tokens - value: {{ max_tokens }} - - name: metadata - value: "{{ metadata }}" - - name: modalities - value: - - "{{ modalities }}" - - name: model - value: "{{ model }}" - description: | - ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - - name: n - value: {{ n }} - - name: parallel_tool_calls - value: {{ parallel_tool_calls }} - description: | - Whether to enable parallel function calling during tool use. - default: true - - name: prediction - value: - content: "{{ content }}" - type: "{{ type }}" - - name: presence_penalty - value: {{ presence_penalty }} - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: reasoning_effort - value: "{{ reasoning_effort }}" - valid_values: ['low', 'medium', 'high'] - - name: response_format - description: | - Specifies the format the model must output. - value: - type: "{{ type }}" - json_schema: - description: "{{ description }}" - name: "{{ name }}" - schema: "{{ schema }}" - strict: {{ strict }} - - name: seed - value: {{ seed }} - - name: service_tier - value: "{{ service_tier }}" - valid_values: ['auto', 'default', 'flex', 'scale', 'priority'] - - name: stop - value: "{{ stop }}" - - name: store - value: {{ store }} - - name: stream - value: {{ stream }} - - name: stream_options - value: - include_obfuscation: {{ include_obfuscation }} - include_usage: {{ include_usage }} - - name: temperature - value: {{ temperature }} - - name: tool_choice - value: "{{ tool_choice }}" - description: | - Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - valid_values: ['none', 'auto', 'required'] - - name: tools - description: | - A list of tools the model may call. - value: - - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: "{{ parameters }}" - strict: {{ strict }} - type: "{{ type }}" - custom: - description: "{{ description }}" - format: - type: "{{ type }}" - grammar: - definition: "{{ definition }}" - syntax: "{{ syntax }}" - name: "{{ name }}" - - name: top_logprobs - value: {{ top_logprobs }} - - name: top_p - value: {{ top_p }} - - name: user - value: "{{ user }}" - description: | - A unique identifier representing your end-user, for abuse monitoring. - - name: web_search_options - description: | - Options for the web search tool (when using built-in web search). - value: - search_context_size: "{{ search_context_size }}" - user_location: - approximate: - city: "{{ city }}" - country: "{{ country }}" - region: "{{ region }}" - timezone: "{{ timezone }}" - type: "{{ type }}" - - name: messages - description: | - A list of messages comprising the conversation so far. - value: - - content: "{{ content }}" - name: "{{ name }}" - role: "{{ role }}" - audio: - id: "{{ id }}" - function_call: - arguments: "{{ arguments }}" - name: "{{ name }}" - refusal: "{{ refusal }}" - tool_calls: "{{ tool_calls }}" - tool_call_id: "{{ tool_call_id }}" - - name: requests - value: - - audio: - format: "{{ format }}" - voice: "{{ voice }}" - chat_template_kwargs: - clear_thinking: {{ clear_thinking }} - enable_thinking: {{ enable_thinking }} - frequency_penalty: {{ frequency_penalty }} - function_call: "{{ function_call }}" - functions: "{{ functions }}" - logit_bias: "{{ logit_bias }}" - logprobs: {{ logprobs }} - max_completion_tokens: {{ max_completion_tokens }} - max_tokens: {{ max_tokens }} - metadata: "{{ metadata }}" - modalities: "{{ modalities }}" - model: "{{ model }}" - n: {{ n }} - parallel_tool_calls: {{ parallel_tool_calls }} - prediction: - content: "{{ content }}" - type: "{{ type }}" - presence_penalty: {{ presence_penalty }} - prompt: "{{ prompt }}" - reasoning_effort: "{{ reasoning_effort }}" - response_format: - type: "{{ type }}" - json_schema: - description: "{{ description }}" - name: "{{ name }}" - schema: "{{ schema }}" - strict: {{ strict }} - seed: {{ seed }} - service_tier: "{{ service_tier }}" - stop: "{{ stop }}" - store: {{ store }} - stream: {{ stream }} - stream_options: - include_obfuscation: {{ include_obfuscation }} - include_usage: {{ include_usage }} - temperature: {{ temperature }} - tool_choice: "{{ tool_choice }}" - tools: "{{ tools }}" - top_logprobs: {{ top_logprobs }} - top_p: {{ top_p }} - user: "{{ user }}" - web_search_options: - search_context_size: "{{ search_context_size }}" - user_location: - approximate: - city: "{{ city }}" - country: "{{ country }}" - region: "{{ region }}" - timezone: "{{ timezone }}" - type: "{{ type }}" - messages: "{{ messages }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_2_13b_chat_awq/index.md b/stackql_cloudflare/website/docs/services/ai/llama_2_13b_chat_awq/index.md deleted file mode 100644 index 337510d1eaf..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_2_13b_chat_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_2_13b_chat_awq -hide_title: false -hide_table_of_contents: false -keywords: - - llama_2_13b_chat_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_2_13b_chat_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/llama-2-13b-chat-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/llama-2-13b-chat-awq model. - -```sql -INSERT INTO cloudflare.ai.llama_2_13b_chat_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_2_13b_chat_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_2_13b_chat_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_fp16/index.md b/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_fp16/index.md deleted file mode 100644 index 17375d601d6..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_fp16/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_2_7b_chat_fp16 -hide_title: false -hide_table_of_contents: false -keywords: - - llama_2_7b_chat_fp16 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_2_7b_chat_fp16 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-2-7b-chat-fp16 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-2-7b-chat-fp16 model. - -```sql -INSERT INTO cloudflare.ai.llama_2_7b_chat_fp16 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_2_7b_chat_fp16 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_2_7b_chat_fp16 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_hf_lora/index.md b/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_hf_lora/index.md deleted file mode 100644 index cd7a1c91876..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_hf_lora/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_2_7b_chat_hf_lora -hide_title: false -hide_table_of_contents: false -keywords: - - llama_2_7b_chat_hf_lora - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_2_7b_chat_hf_lora resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta-llama/llama-2-7b-chat-hf-lora model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta-llama/llama-2-7b-chat-hf-lora model. - -```sql -INSERT INTO cloudflare.ai.llama_2_7b_chat_hf_lora ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_2_7b_chat_hf_lora - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_2_7b_chat_hf_lora resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_int8/index.md b/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_int8/index.md deleted file mode 100644 index 88e71981257..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_2_7b_chat_int8/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_2_7b_chat_int8 -hide_title: false -hide_table_of_contents: false -keywords: - - llama_2_7b_chat_int8 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_2_7b_chat_int8 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-2-7b-chat-int8 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-2-7b-chat-int8 model. - -```sql -INSERT INTO cloudflare.ai.llama_2_7b_chat_int8 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_2_7b_chat_int8 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_2_7b_chat_int8 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_1_70b_instruct_fp8_fast/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_1_70b_instruct_fp8_fast/index.md deleted file mode 100644 index dbbce37f316..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_1_70b_instruct_fp8_fast/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_1_70b_instruct_fp8_fast -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_1_70b_instruct_fp8_fast - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_1_70b_instruct_fp8_fast resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.1-70b-instruct-fp8-fast model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.1-70b-instruct-fp8-fast model. - -```sql -INSERT INTO cloudflare.ai.llama_3_1_70b_instruct_fp8_fast ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_1_70b_instruct_fp8_fast - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_1_70b_instruct_fp8_fast resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_awq/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_awq/index.md deleted file mode 100644 index 5c749f30aad..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_1_8b_instruct_awq -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_1_8b_instruct_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_1_8b_instruct_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.1-8b-instruct-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.1-8b-instruct-awq model. - -```sql -INSERT INTO cloudflare.ai.llama_3_1_8b_instruct_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_1_8b_instruct_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_1_8b_instruct_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_fp8/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_fp8/index.md deleted file mode 100644 index 6e8cab9a6f1..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_fp8/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_1_8b_instruct_fp8 -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_1_8b_instruct_fp8 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_1_8b_instruct_fp8 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.1-8b-instruct-fp8 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.1-8b-instruct-fp8 model. - -```sql -INSERT INTO cloudflare.ai.llama_3_1_8b_instruct_fp8 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_1_8b_instruct_fp8 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_1_8b_instruct_fp8 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_fp8_fast/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_fp8_fast/index.md deleted file mode 100644 index 9d30dacf924..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_1_8b_instruct_fp8_fast/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_1_8b_instruct_fp8_fast -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_1_8b_instruct_fp8_fast - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_1_8b_instruct_fp8_fast resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.1-8b-instruct-fp8-fast model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.1-8b-instruct-fp8-fast model. - -```sql -INSERT INTO cloudflare.ai.llama_3_1_8b_instruct_fp8_fast ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_1_8b_instruct_fp8_fast - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_1_8b_instruct_fp8_fast resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_2_11b_vision_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_2_11b_vision_instruct/index.md deleted file mode 100644 index 272060b49cd..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_2_11b_vision_instruct/index.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -title: llama_3_2_11b_vision_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_2_11b_vision_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_2_11b_vision_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.2-11b-vision-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.2-11b-vision-instruct model. - -```sql -INSERT INTO cloudflare.ai.llama_3_2_11b_vision_instruct ( -frequency_penalty, -image, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ image }}', -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_2_11b_vision_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_2_11b_vision_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: image - value: - - {{ image }} - description: | - An array of integers that represent the image data constrained to 8-bit unsigned integer values. Deprecated, use image as a part of messages now. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - tool_call_id: "{{ tool_call_id }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_2_1b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_2_1b_instruct/index.md deleted file mode 100644 index 2b8c3960433..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_2_1b_instruct/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_2_1b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_2_1b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_2_1b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.2-1b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.2-1b-instruct model. - -```sql -INSERT INTO cloudflare.ai.llama_3_2_1b_instruct ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_2_1b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_2_1b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_2_3b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_2_3b_instruct/index.md deleted file mode 100644 index 47a5826bae6..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_2_3b_instruct/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_2_3b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_2_3b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_2_3b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.2-3b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.2-3b-instruct model. - -```sql -INSERT INTO cloudflare.ai.llama_3_2_3b_instruct ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_2_3b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_2_3b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_3_70b_instruct_fp8_fast/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_3_70b_instruct_fp8_fast/index.md deleted file mode 100644 index 562032d6f67..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_3_70b_instruct_fp8_fast/index.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -title: llama_3_3_70b_instruct_fp8_fast -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_3_70b_instruct_fp8_fast - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_3_70b_instruct_fp8_fast resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3.3-70b-instruct-fp8-fast model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3.3-70b-instruct-fp8-fast model. - -```sql -INSERT INTO cloudflare.ai.llama_3_3_70b_instruct_fp8_fast ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -requests, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_3_70b_instruct_fp8_fast - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_3_70b_instruct_fp8_fast resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: requests - value: - - external_reference: "{{ external_reference }}" - frequency_penalty: {{ frequency_penalty }} - max_tokens: {{ max_tokens }} - presence_penalty: {{ presence_penalty }} - prompt: "{{ prompt }}" - repetition_penalty: {{ repetition_penalty }} - response_format: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - seed: {{ seed }} - stream: {{ stream }} - temperature: {{ temperature }} - top_p: {{ top_p }} - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_8b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_8b_instruct/index.md deleted file mode 100644 index e8dba82d8c0..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_8b_instruct/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_8b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_8b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_8b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3-8b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3-8b-instruct model. - -```sql -INSERT INTO cloudflare.ai.llama_3_8b_instruct ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_8b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_8b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_3_8b_instruct_awq/index.md b/stackql_cloudflare/website/docs/services/ai/llama_3_8b_instruct_awq/index.md deleted file mode 100644 index 88e21ae7894..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_3_8b_instruct_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: llama_3_8b_instruct_awq -hide_title: false -hide_table_of_contents: false -keywords: - - llama_3_8b_instruct_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_3_8b_instruct_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-3-8b-instruct-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-3-8b-instruct-awq model. - -```sql -INSERT INTO cloudflare.ai.llama_3_8b_instruct_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_3_8b_instruct_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_3_8b_instruct_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_4_scout_17b_16e_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/llama_4_scout_17b_16e_instruct/index.md deleted file mode 100644 index d653dd5791e..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_4_scout_17b_16e_instruct/index.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -title: llama_4_scout_17b_16e_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - llama_4_scout_17b_16e_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_4_scout_17b_16e_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/llama-4-scout-17b-16e-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-4-scout-17b-16e-instruct model. - -```sql -INSERT INTO cloudflare.ai.llama_4_scout_17b_16e_instruct ( -frequency_penalty, -guided_json, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -requests, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ guided_json }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_4_scout_17b_16e_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_4_scout_17b_16e_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: guided_json - value: "{{ guided_json }}" - description: | - JSON schema that should be fulfilled for the response. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.15 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - tool_call_id: "{{ tool_call_id }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: requests - value: - - frequency_penalty: {{ frequency_penalty }} - guided_json: "{{ guided_json }}" - max_tokens: {{ max_tokens }} - presence_penalty: {{ presence_penalty }} - prompt: "{{ prompt }}" - raw: {{ raw }} - repetition_penalty: {{ repetition_penalty }} - response_format: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - seed: {{ seed }} - stream: {{ stream }} - temperature: {{ temperature }} - top_k: {{ top_k }} - top_p: {{ top_p }} - functions: "{{ functions }}" - messages: "{{ messages }}" - tools: "{{ tools }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/llama_guard_3_8b/index.md b/stackql_cloudflare/website/docs/services/ai/llama_guard_3_8b/index.md deleted file mode 100644 index 0260da1f2a7..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/llama_guard_3_8b/index.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: llama_guard_3_8b -hide_title: false -hide_table_of_contents: false -keywords: - - llama_guard_3_8b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a llama_guard_3_8b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, messagesqueueRequest, tagsRuns inference on the @cf/meta/llama-guard-3-8b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/llama-guard-3-8b model. - -```sql -INSERT INTO cloudflare.ai.llama_guard_3_8b ( -max_tokens, -messages, -response_format, -temperature, -account_id, -queueRequest, -tags -) -SELECT -{{ max_tokens }}, -'{{ messages }}' /* required */, -'{{ response_format }}', -{{ temperature }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: llama_guard_3_8b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the llama_guard_3_8b resource. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: response_format - description: | - Dictate the output format of the generated response. - value: - type: "{{ type }}" - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/lucid_origin/index.md b/stackql_cloudflare/website/docs/services/ai/lucid_origin/index.md deleted file mode 100644 index 6c08c1fe021..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/lucid_origin/index.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: lucid_origin -hide_title: false -hide_table_of_contents: false -keywords: - - lucid_origin - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a lucid_origin resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/leonardo/lucid-origin model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/leonardo/lucid-origin model. - -```sql -INSERT INTO cloudflare.ai.lucid_origin ( -guidance, -height, -num_steps, -prompt, -seed, -steps, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ steps }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: lucid_origin - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the lucid_origin resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 4.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - default: 1120 - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate. - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: steps - value: {{ steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - default: 1120 - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/m2m100_1_2b/index.md b/stackql_cloudflare/website/docs/services/ai/m2m100_1_2b/index.md deleted file mode 100644 index b9233b068b8..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/m2m100_1_2b/index.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: m2m100_1_2b -hide_title: false -hide_table_of_contents: false -keywords: - - m2m100_1_2b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a m2m100_1_2b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/meta/m2m100-1.2b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/meta/m2m100-1.2b model. - -```sql -INSERT INTO cloudflare.ai.m2m100_1_2b ( -source_lang, -target_lang, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ source_lang }}', -'{{ target_lang }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: m2m100_1_2b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the m2m100_1_2b resource. - - name: source_lang - value: "{{ source_lang }}" - description: | - The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified - default: en - - name: target_lang - value: "{{ target_lang }}" - description: | - The language code to translate the text into (e.g., 'es' for Spanish) - - name: text - value: "{{ text }}" - description: | - The text to be translated - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - source_lang: "{{ source_lang }}" - target_lang: "{{ target_lang }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/melotts/index.md b/stackql_cloudflare/website/docs/services/ai/melotts/index.md deleted file mode 100644 index 323ce35044f..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/melotts/index.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: melotts -hide_title: false -hide_table_of_contents: false -keywords: - - melotts - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a melotts resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/myshell-ai/melotts model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/myshell-ai/melotts model. - -```sql -INSERT INTO cloudflare.ai.melotts ( -lang, -prompt, -account_id, -queueRequest, -tags -) -SELECT -'{{ lang }}', -'{{ prompt }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: melotts - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the melotts resource. - - name: lang - value: "{{ lang }}" - description: | - The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified - default: en - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the audio you want to generate - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_1/index.md b/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_1/index.md deleted file mode 100644 index fff0340b2ae..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_1/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: mistral_7b_instruct_v0_1 -hide_title: false -hide_table_of_contents: false -keywords: - - mistral_7b_instruct_v0_1 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a mistral_7b_instruct_v0_1 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/mistral/mistral-7b-instruct-v0.1 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/mistral/mistral-7b-instruct-v0.1 model. - -```sql -INSERT INTO cloudflare.ai.mistral_7b_instruct_v0_1 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: mistral_7b_instruct_v0_1 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the mistral_7b_instruct_v0_1 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_1_awq/index.md b/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_1_awq/index.md deleted file mode 100644 index ec954e4c184..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_1_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: mistral_7b_instruct_v0_1_awq -hide_title: false -hide_table_of_contents: false -keywords: - - mistral_7b_instruct_v0_1_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a mistral_7b_instruct_v0_1_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/mistral-7b-instruct-v0.1-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/mistral-7b-instruct-v0.1-awq model. - -```sql -INSERT INTO cloudflare.ai.mistral_7b_instruct_v0_1_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: mistral_7b_instruct_v0_1_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the mistral_7b_instruct_v0_1_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_2/index.md b/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_2/index.md deleted file mode 100644 index 80e15b6487e..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_2/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: mistral_7b_instruct_v0_2 -hide_title: false -hide_table_of_contents: false -keywords: - - mistral_7b_instruct_v0_2 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a mistral_7b_instruct_v0_2 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/mistral/mistral-7b-instruct-v0.2 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/mistral/mistral-7b-instruct-v0.2 model. - -```sql -INSERT INTO cloudflare.ai.mistral_7b_instruct_v0_2 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: mistral_7b_instruct_v0_2 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the mistral_7b_instruct_v0_2 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_2_lora/index.md b/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_2_lora/index.md deleted file mode 100644 index b26f17e7217..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/mistral_7b_instruct_v0_2_lora/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: mistral_7b_instruct_v0_2_lora -hide_title: false -hide_table_of_contents: false -keywords: - - mistral_7b_instruct_v0_2_lora - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a mistral_7b_instruct_v0_2_lora resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/mistral/mistral-7b-instruct-v0.2-lora model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/mistral/mistral-7b-instruct-v0.2-lora model. - -```sql -INSERT INTO cloudflare.ai.mistral_7b_instruct_v0_2_lora ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: mistral_7b_instruct_v0_2_lora - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the mistral_7b_instruct_v0_2_lora resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/mistral_small_3_1_24b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/mistral_small_3_1_24b_instruct/index.md deleted file mode 100644 index 47cdf2a0277..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/mistral_small_3_1_24b_instruct/index.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -title: mistral_small_3_1_24b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - mistral_small_3_1_24b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a mistral_small_3_1_24b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/mistralai/mistral-small-3.1-24b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/mistralai/mistral-small-3.1-24b-instruct model. - -```sql -INSERT INTO cloudflare.ai.mistral_small_3_1_24b_instruct ( -frequency_penalty, -guided_json, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ guided_json }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: mistral_small_3_1_24b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the mistral_small_3_1_24b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: guided_json - value: "{{ guided_json }}" - description: | - JSON schema that should be fulfilled for the response. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.15 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - tool_call_id: "{{ tool_call_id }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/models/index.md b/stackql_cloudflare/website/docs/services/ai/models/index.md index 8d06401e0c3..c2e468feade 100644 --- a/stackql_cloudflare/website/docs/services/ai/models/index.md +++ b/stackql_cloudflare/website/docs/services/ai/models/index.md @@ -51,6 +51,46 @@ Returns a list of models + + + string + Model identifier (UUID). + + + + string + Model name, e.g. @cf/meta/llama-3.2-1b-instruct - use as model_name in the ai task-family resources. + + + + string + + + + + string + + + + + array + + + + + number + + + + + array + + + + + object + Task grouping: id, name (e.g. Text Generation), description. + @@ -151,7 +191,14 @@ Searches Workers AI models by name or description. ```sql SELECT -* +id, +name, +created_at, +description, +properties, +source, +tags, +task FROM cloudflare.ai.models WHERE account_id = '{{ account_id }}' -- required AND per_page = '{{ per_page }}' diff --git a/stackql_cloudflare/website/docs/services/ai/nemotron_3_120b_a12b/index.md b/stackql_cloudflare/website/docs/services/ai/nemotron_3_120b_a12b/index.md deleted file mode 100644 index 9565f024e2b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nemotron_3_120b_a12b/index.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -title: nemotron_3_120b_a12b -hide_title: false -hide_table_of_contents: false -keywords: - - nemotron_3_120b_a12b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nemotron_3_120b_a12b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/nvidia/nemotron-3-120b-a12b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/nvidia/nemotron-3-120b-a12b model. - -```sql -INSERT INTO cloudflare.ai.nemotron_3_120b_a12b ( -audio, -chat_template_kwargs, -frequency_penalty, -function_call, -functions, -logit_bias, -logprobs, -max_completion_tokens, -max_tokens, -metadata, -modalities, -model, -n, -parallel_tool_calls, -prediction, -presence_penalty, -prompt, -reasoning_effort, -response_format, -seed, -service_tier, -stop, -store, -stream, -stream_options, -temperature, -tool_choice, -tools, -top_logprobs, -top_p, -user, -web_search_options, -messages, -account_id, -queueRequest, -tags -) -SELECT -'{{ audio }}', -'{{ chat_template_kwargs }}', -{{ frequency_penalty }}, -'{{ function_call }}', -'{{ functions }}', -'{{ logit_bias }}', -{{ logprobs }}, -{{ max_completion_tokens }}, -{{ max_tokens }}, -'{{ metadata }}', -'{{ modalities }}', -'{{ model }}', -{{ n }}, -{{ parallel_tool_calls }}, -'{{ prediction }}', -{{ presence_penalty }}, -'{{ prompt }}', -'{{ reasoning_effort }}', -'{{ response_format }}', -{{ seed }}, -'{{ service_tier }}', -'{{ stop }}', -{{ store }}, -{{ stream }}, -'{{ stream_options }}', -{{ temperature }}, -'{{ tool_choice }}', -'{{ tools }}', -{{ top_logprobs }}, -{{ top_p }}, -'{{ user }}', -'{{ web_search_options }}', -'{{ messages }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nemotron_3_120b_a12b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nemotron_3_120b_a12b resource. - - name: audio - description: | - Parameters for audio output. Required when modalities includes 'audio'. - value: - format: "{{ format }}" - voice: "{{ voice }}" - - name: chat_template_kwargs - value: - clear_thinking: {{ clear_thinking }} - enable_thinking: {{ enable_thinking }} - - name: frequency_penalty - value: {{ frequency_penalty }} - - name: function_call - value: "{{ function_call }}" - valid_values: ['none', 'auto'] - - name: functions - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: "{{ parameters }}" - strict: {{ strict }} - - name: logit_bias - value: "{{ logit_bias }}" - - name: logprobs - value: {{ logprobs }} - - name: max_completion_tokens - value: {{ max_completion_tokens }} - - name: max_tokens - value: {{ max_tokens }} - - name: metadata - value: "{{ metadata }}" - - name: modalities - value: - - "{{ modalities }}" - - name: model - value: "{{ model }}" - description: | - ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, etc'). - - name: n - value: {{ n }} - - name: parallel_tool_calls - value: {{ parallel_tool_calls }} - description: | - Whether to enable parallel function calling during tool use. - default: true - - name: prediction - value: - content: "{{ content }}" - type: "{{ type }}" - - name: presence_penalty - value: {{ presence_penalty }} - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: reasoning_effort - value: "{{ reasoning_effort }}" - valid_values: ['low', 'medium', 'high'] - - name: response_format - description: | - Specifies the format the model must output. - value: - type: "{{ type }}" - json_schema: - description: "{{ description }}" - name: "{{ name }}" - schema: "{{ schema }}" - strict: {{ strict }} - - name: seed - value: {{ seed }} - - name: service_tier - value: "{{ service_tier }}" - valid_values: ['auto', 'default', 'flex', 'scale', 'priority'] - - name: stop - value: "{{ stop }}" - - name: store - value: {{ store }} - - name: stream - value: {{ stream }} - - name: stream_options - value: - include_obfuscation: {{ include_obfuscation }} - include_usage: {{ include_usage }} - - name: temperature - value: {{ temperature }} - - name: tool_choice - value: "{{ tool_choice }}" - description: | - Controls which (if any) tool is called by the model. 'none' = no tools, 'auto' = model decides, 'required' = must call a tool. - valid_values: ['none', 'auto', 'required'] - - name: tools - description: | - A list of tools the model may call. - value: - - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: "{{ parameters }}" - strict: {{ strict }} - type: "{{ type }}" - custom: - description: "{{ description }}" - format: - type: "{{ type }}" - grammar: - definition: "{{ definition }}" - syntax: "{{ syntax }}" - name: "{{ name }}" - - name: top_logprobs - value: {{ top_logprobs }} - - name: top_p - value: {{ top_p }} - - name: user - value: "{{ user }}" - description: | - A unique identifier representing your end-user, for abuse monitoring. - - name: web_search_options - description: | - Options for the web search tool (when using built-in web search). - value: - search_context_size: "{{ search_context_size }}" - user_location: - approximate: - city: "{{ city }}" - country: "{{ country }}" - region: "{{ region }}" - timezone: "{{ timezone }}" - type: "{{ type }}" - - name: messages - description: | - A list of messages comprising the conversation so far. - value: - - content: "{{ content }}" - name: "{{ name }}" - role: "{{ role }}" - audio: - id: "{{ id }}" - function_call: - arguments: "{{ arguments }}" - name: "{{ name }}" - refusal: "{{ refusal }}" - tool_calls: "{{ tool_calls }}" - tool_call_id: "{{ tool_call_id }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/neural_chat_7b_v3_1_awq/index.md b/stackql_cloudflare/website/docs/services/ai/neural_chat_7b_v3_1_awq/index.md deleted file mode 100644 index 323f5283869..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/neural_chat_7b_v3_1_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: neural_chat_7b_v3_1_awq -hide_title: false -hide_table_of_contents: false -keywords: - - neural_chat_7b_v3_1_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a neural_chat_7b_v3_1_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/neural-chat-7b-v3-1-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/neural-chat-7b-v3-1-awq model. - -```sql -INSERT INTO cloudflare.ai.neural_chat_7b_v3_1_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: neural_chat_7b_v3_1_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the neural_chat_7b_v3_1_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_bart_large_cnn/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_bart_large_cnn/index.md deleted file mode 100644 index f74dccf0b75..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_bart_large_cnn/index.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: nonomni_bart_large_cnn -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_bart_large_cnn - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_bart_large_cnn resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, input_textqueueRequest, tagsRuns inference on the @cf/facebook/nonomni-bart-large-cnn model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/facebook/nonomni-bart-large-cnn model. - -```sql -INSERT INTO cloudflare.ai.nonomni_bart_large_cnn ( -input_text, -max_length, -account_id, -queueRequest, -tags -) -SELECT -'{{ input_text }}' /* required */, -{{ max_length }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_bart_large_cnn - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_bart_large_cnn resource. - - name: input_text - value: "{{ input_text }}" - description: | - The text that you want the model to summarize - - name: max_length - value: {{ max_length }} - description: | - The maximum length of the generated summary in tokens - default: 1024 - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_base_en_v1_5/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_bge_base_en_v1_5/index.md deleted file mode 100644 index 20f5349e7a0..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_base_en_v1_5/index.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: nonomni_bge_base_en_v1_5 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_bge_base_en_v1_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_bge_base_en_v1_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/nonomni-bge-base-en-v1.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/nonomni-bge-base-en-v1.5 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_bge_base_en_v1_5 ( -pooling, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ pooling }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_bge_base_en_v1_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_bge_base_en_v1_5 resource. - - name: pooling - value: "{{ pooling }}" - description: | - The pooling method used in the embedding process. \`cls\` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is \`mean\` in order for this to not be a breaking change, but we highly suggest using the new \`cls\` pooling for better accuracy. - valid_values: ['mean', 'cls'] - default: mean - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - pooling: "{{ pooling }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_large_en_v1_5/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_bge_large_en_v1_5/index.md deleted file mode 100644 index 342be7ea2cb..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_large_en_v1_5/index.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: nonomni_bge_large_en_v1_5 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_bge_large_en_v1_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_bge_large_en_v1_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/nonomni-bge-large-en-v1.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/nonomni-bge-large-en-v1.5 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_bge_large_en_v1_5 ( -pooling, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ pooling }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_bge_large_en_v1_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_bge_large_en_v1_5 resource. - - name: pooling - value: "{{ pooling }}" - description: | - The pooling method used in the embedding process. \`cls\` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is \`mean\` in order for this to not be a breaking change, but we highly suggest using the new \`cls\` pooling for better accuracy. - valid_values: ['mean', 'cls'] - default: mean - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - pooling: "{{ pooling }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_m3/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_bge_m3/index.md deleted file mode 100644 index ad85bfb277e..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_m3/index.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: nonomni_bge_m3 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_bge_m3 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_bge_m3 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/nonomni-bge-m3 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/nonomni-bge-m3 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_bge_m3 ( -contexts, -query, -truncate_inputs, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ contexts }}', -'{{ query }}', -{{ truncate_inputs }}, -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_bge_m3 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_bge_m3 resource. - - name: contexts - description: | - List of provided contexts. Note that the index in this array is important, as the response will refer to it. - value: - - text: "{{ text }}" - - name: query - value: "{{ query }}" - description: | - A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts - - name: truncate_inputs - value: {{ truncate_inputs }} - description: | - When provided with too long context should the model error out or truncate the context to fit? - default: false - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - contexts: "{{ contexts }}" - query: "{{ query }}" - truncate_inputs: {{ truncate_inputs }} - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_small_en_v1_5/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_bge_small_en_v1_5/index.md deleted file mode 100644 index 9308a71debd..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_bge_small_en_v1_5/index.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: nonomni_bge_small_en_v1_5 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_bge_small_en_v1_5 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_bge_small_en_v1_5 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/baai/nonomni-bge-small-en-v1.5 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/baai/nonomni-bge-small-en-v1.5 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_bge_small_en_v1_5 ( -pooling, -text, -requests, -account_id, -queueRequest, -tags -) -SELECT -'{{ pooling }}', -'{{ text }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_bge_small_en_v1_5 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_bge_small_en_v1_5 resource. - - name: pooling - value: "{{ pooling }}" - description: | - The pooling method used in the embedding process. \`cls\` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is \`mean\` in order for this to not be a breaking change, but we highly suggest using the new \`cls\` pooling for better accuracy. - valid_values: ['mean', 'cls'] - default: mean - - name: text - value: "{{ text }}" - description: | - The text to embed - - name: requests - description: | - Batch of the embeddings requests to run using async-queue - value: - - pooling: "{{ pooling }}" - text: "{{ text }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_detr_resnet_50/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_detr_resnet_50/index.md deleted file mode 100644 index bd826773412..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_detr_resnet_50/index.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: nonomni_detr_resnet_50 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_detr_resnet_50 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_detr_resnet_50 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/facebook/nonomni-detr-resnet-50 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/facebook/nonomni-detr-resnet-50 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_detr_resnet_50 ( -account_id, -queueRequest, -tags -) -SELECT -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_detr_resnet_50 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_detr_resnet_50 resource. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_distilbert_sst_2_int8/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_distilbert_sst_2_int8/index.md deleted file mode 100644 index cc8c9108fe1..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_distilbert_sst_2_int8/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: nonomni_distilbert_sst_2_int8 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_distilbert_sst_2_int8 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_distilbert_sst_2_int8 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/huggingface/nonomni-distilbert-sst-2-int8 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/huggingface/nonomni-distilbert-sst-2-int8 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_distilbert_sst_2_int8 ( -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_distilbert_sst_2_int8 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_distilbert_sst_2_int8 resource. - - name: text - value: "{{ text }}" - description: | - The text that you want to classify - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_embeddinggemma_300m/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_embeddinggemma_300m/index.md deleted file mode 100644 index 33da6c70cb6..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_embeddinggemma_300m/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: nonomni_embeddinggemma_300m -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_embeddinggemma_300m - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_embeddinggemma_300m resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/google/nonomni-embeddinggemma-300m model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/google/nonomni-embeddinggemma-300m model. - -```sql -INSERT INTO cloudflare.ai.nonomni_embeddinggemma_300m ( -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_embeddinggemma_300m - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_embeddinggemma_300m resource. - - name: text - value: "{{ text }}" - description: | - Input text to embed. Can be a single string or a list of strings. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_indictrans2_en_indic_1b/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_indictrans2_en_indic_1b/index.md deleted file mode 100644 index 9df8801764a..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_indictrans2_en_indic_1b/index.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: nonomni_indictrans2_en_indic_1b -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_indictrans2_en_indic_1b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_indictrans2_en_indic_1b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, text, target_languagequeueRequest, tagsRuns inference on the @cf/ai4bharat/nonomni-indictrans2-en-indic-1b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/ai4bharat/nonomni-indictrans2-en-indic-1b model. - -```sql -INSERT INTO cloudflare.ai.nonomni_indictrans2_en_indic_1b ( -target_language, -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ target_language }}' /* required */, -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_indictrans2_en_indic_1b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_indictrans2_en_indic_1b resource. - - name: target_language - value: "{{ target_language }}" - description: | - Target langauge to translate to - valid_values: ['asm_Beng', 'awa_Deva', 'ben_Beng', 'bho_Deva', 'brx_Deva', 'doi_Deva', 'eng_Latn', 'gom_Deva', 'gon_Deva', 'guj_Gujr', 'hin_Deva', 'hne_Deva', 'kan_Knda', 'kas_Arab', 'kas_Deva', 'kha_Latn', 'lus_Latn', 'mag_Deva', 'mai_Deva', 'mal_Mlym', 'mar_Deva', 'mni_Beng', 'mni_Mtei', 'npi_Deva', 'ory_Orya', 'pan_Guru', 'san_Deva', 'sat_Olck', 'snd_Arab', 'snd_Deva', 'tam_Taml', 'tel_Telu', 'urd_Arab', 'unr_Deva'] - default: hin_Deva - - name: text - value: "{{ text }}" - description: | - Input text to translate. Can be a single string or a list of strings. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nonomni_resnet_50/index.md b/stackql_cloudflare/website/docs/services/ai/nonomni_resnet_50/index.md deleted file mode 100644 index d628432f564..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nonomni_resnet_50/index.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: nonomni_resnet_50 -hide_title: false -hide_table_of_contents: false -keywords: - - nonomni_resnet_50 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nonomni_resnet_50 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/microsoft/nonomni-resnet-50 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/microsoft/nonomni-resnet-50 model. - -```sql -INSERT INTO cloudflare.ai.nonomni_resnet_50 ( -account_id, -queueRequest, -tags -) -SELECT -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nonomni_resnet_50 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nonomni_resnet_50 resource. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/nova_3/index.md b/stackql_cloudflare/website/docs/services/ai/nova_3/index.md deleted file mode 100644 index 46ad3177b7a..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/nova_3/index.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -title: nova_3 -hide_title: false -hide_table_of_contents: false -keywords: - - nova_3 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a nova_3 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, audioqueueRequest, tagsRuns inference on the @cf/deepgram/nova-3 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/deepgram/nova-3 model. - -```sql -INSERT INTO cloudflare.ai.nova_3 ( -audio, -channels, -custom_intent, -custom_intent_mode, -custom_topic, -custom_topic_mode, -detect_entities, -detect_language, -diarize, -dictation, -encoding, -endpointing, -extra, -filler_words, -interim_results, -keyterm, -keywords, -language, -measurements, -mip_opt_out, -mode, -multichannel, -numerals, -paragraphs, -profanity_filter, -punctuate, -redact, -replace, -search, -sentiment, -smart_format, -topics, -utt_split, -utterance_end_ms, -utterances, -vad_events, -account_id, -queueRequest, -tags -) -SELECT -'{{ audio }}' /* required */, -{{ channels }}, -'{{ custom_intent }}', -'{{ custom_intent_mode }}', -'{{ custom_topic }}', -'{{ custom_topic_mode }}', -{{ detect_entities }}, -{{ detect_language }}, -{{ diarize }}, -{{ dictation }}, -'{{ encoding }}', -'{{ endpointing }}', -'{{ extra }}', -{{ filler_words }}, -{{ interim_results }}, -'{{ keyterm }}', -'{{ keywords }}', -'{{ language }}', -{{ measurements }}, -{{ mip_opt_out }}, -'{{ mode }}', -{{ multichannel }}, -{{ numerals }}, -{{ paragraphs }}, -{{ profanity_filter }}, -{{ punctuate }}, -'{{ redact }}', -'{{ replace }}', -'{{ search }}', -{{ sentiment }}, -{{ smart_format }}, -{{ topics }}, -{{ utt_split }}, -{{ utterance_end_ms }}, -{{ utterances }}, -{{ vad_events }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: nova_3 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the nova_3 resource. - - name: audio - value: - body: "{{ body }}" - contentType: "{{ contentType }}" - - name: channels - value: {{ channels }} - description: | - The number of channels in the submitted audio - - name: custom_intent - value: "{{ custom_intent }}" - description: | - Custom intents you want the model to detect within your input audio if present - - name: custom_intent_mode - value: "{{ custom_intent_mode }}" - description: | - Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param - valid_values: ['extended', 'strict'] - - name: custom_topic - value: "{{ custom_topic }}" - description: | - Custom topics you want the model to detect within your input audio or text if present Submit up to 100 - - name: custom_topic_mode - value: "{{ custom_topic_mode }}" - description: | - Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. - valid_values: ['extended', 'strict'] - - name: detect_entities - value: {{ detect_entities }} - description: | - Identifies and extracts key entities from content in submitted audio - - name: detect_language - value: {{ detect_language }} - description: | - Identifies the dominant language spoken in submitted audio - - name: diarize - value: {{ diarize }} - description: | - Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 - - name: dictation - value: {{ dictation }} - description: | - Identify and extract key entities from content in submitted audio - - name: encoding - value: "{{ encoding }}" - description: | - Specify the expected encoding of your submitted audio - valid_values: ['linear16', 'flac', 'mulaw', 'amr-nb', 'amr-wb', 'opus', 'speex', 'g729'] - - name: endpointing - value: "{{ endpointing }}" - description: | - Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing - - name: extra - value: "{{ extra }}" - description: | - Arbitrary key-value pairs that are attached to the API response for usage in downstream processing - - name: filler_words - value: {{ filler_words }} - description: | - Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um' - - name: interim_results - value: {{ interim_results }} - description: | - Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets. - - name: keyterm - value: "{{ keyterm }}" - description: | - Key term prompting can boost or suppress specialized terminology and brands. - - name: keywords - value: "{{ keywords }}" - description: | - Keywords can boost or suppress specialized terminology and brands. - - name: language - value: "{{ language }}" - description: | - The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available. - - name: measurements - value: {{ measurements }} - description: | - Spoken measurements will be converted to their corresponding abbreviations. - - name: mip_opt_out - value: {{ mip_opt_out }} - description: | - Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip. - - name: mode - value: "{{ mode }}" - description: | - Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio - valid_values: ['general', 'medical', 'finance'] - - name: multichannel - value: {{ multichannel }} - description: | - Transcribe each audio channel independently. - - name: numerals - value: {{ numerals }} - description: | - Numerals converts numbers from written format to numerical format. - - name: paragraphs - value: {{ paragraphs }} - description: | - Splits audio into paragraphs to improve transcript readability. - - name: profanity_filter - value: {{ profanity_filter }} - description: | - Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely. - - name: punctuate - value: {{ punctuate }} - description: | - Add punctuation and capitalization to the transcript. - - name: redact - value: "{{ redact }}" - description: | - Redaction removes sensitive information from your transcripts. - - name: replace - value: "{{ replace }}" - description: | - Search for terms or phrases in submitted audio and replaces them. - - name: search - value: "{{ search }}" - description: | - Search for terms or phrases in submitted audio. - - name: sentiment - value: {{ sentiment }} - description: | - Recognizes the sentiment throughout a transcript or text. - - name: smart_format - value: {{ smart_format }} - description: | - Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. - - name: topics - value: {{ topics }} - description: | - Detect topics throughout a transcript or text. - - name: utt_split - value: {{ utt_split }} - description: | - Seconds to wait before detecting a pause between words in submitted audio. - - name: utterance_end_ms - value: {{ utterance_end_ms }} - description: | - Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets. - - name: utterances - value: {{ utterances }} - description: | - Segments speech into meaningful semantic units. - - name: vad_events - value: {{ vad_events }} - description: | - Indicates that speech has started. You'll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/openchat_3_5_0106/index.md b/stackql_cloudflare/website/docs/services/ai/openchat_3_5_0106/index.md deleted file mode 100644 index 0b970c1ea9b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/openchat_3_5_0106/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: openchat_3_5_0106 -hide_title: false -hide_table_of_contents: false -keywords: - - openchat_3_5_0106 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an openchat_3_5_0106 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/openchat/openchat-3.5-0106 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/openchat/openchat-3.5-0106 model. - -```sql -INSERT INTO cloudflare.ai.openchat_3_5_0106 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: openchat_3_5_0106 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the openchat_3_5_0106 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/openhermes_2_5_mistral_7b_awq/index.md b/stackql_cloudflare/website/docs/services/ai/openhermes_2_5_mistral_7b_awq/index.md deleted file mode 100644 index d02e7245a91..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/openhermes_2_5_mistral_7b_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: openhermes_2_5_mistral_7b_awq -hide_title: false -hide_table_of_contents: false -keywords: - - openhermes_2_5_mistral_7b_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an openhermes_2_5_mistral_7b_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/openhermes-2.5-mistral-7b-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/openhermes-2.5-mistral-7b-awq model. - -```sql -INSERT INTO cloudflare.ai.openhermes_2_5_mistral_7b_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: openhermes_2_5_mistral_7b_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the openhermes_2_5_mistral_7b_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/phi_2/index.md b/stackql_cloudflare/website/docs/services/ai/phi_2/index.md deleted file mode 100644 index cff351b5a02..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/phi_2/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: phi_2 -hide_title: false -hide_table_of_contents: false -keywords: - - phi_2 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a phi_2 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/microsoft/phi-2 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/microsoft/phi-2 model. - -```sql -INSERT INTO cloudflare.ai.phi_2 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: phi_2 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the phi_2 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/phoenix_1_0/index.md b/stackql_cloudflare/website/docs/services/ai/phoenix_1_0/index.md deleted file mode 100644 index f794dd4e854..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/phoenix_1_0/index.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: phoenix_1_0 -hide_title: false -hide_table_of_contents: false -keywords: - - phoenix_1_0 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a phoenix_1_0 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/leonardo/phoenix-1.0 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/leonardo/phoenix-1.0 model. - -```sql -INSERT INTO cloudflare.ai.phoenix_1_0 ( -guidance, -height, -negative_prompt, -num_steps, -prompt, -seed, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: phoenix_1_0 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the phoenix_1_0 resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 2 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - default: 1024 - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Specify what to exclude from the generated images - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 25 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate. - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - default: 1024 - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/plamo_embedding_1b/index.md b/stackql_cloudflare/website/docs/services/ai/plamo_embedding_1b/index.md deleted file mode 100644 index 61c447eae05..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/plamo_embedding_1b/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: plamo_embedding_1b -hide_title: false -hide_table_of_contents: false -keywords: - - plamo_embedding_1b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a plamo_embedding_1b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, textqueueRequest, tagsRuns inference on the @cf/pfnet/plamo-embedding-1b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/pfnet/plamo-embedding-1b model. - -```sql -INSERT INTO cloudflare.ai.plamo_embedding_1b ( -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ text }}' /* required */, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: plamo_embedding_1b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the plamo_embedding_1b resource. - - name: text - value: "{{ text }}" - description: | - Input text to embed. Can be a single string or a list of strings. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen1_5_0_5b_chat/index.md b/stackql_cloudflare/website/docs/services/ai/qwen1_5_0_5b_chat/index.md deleted file mode 100644 index 87be1f7efb0..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen1_5_0_5b_chat/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: qwen1_5_0_5b_chat -hide_title: false -hide_table_of_contents: false -keywords: - - qwen1_5_0_5b_chat - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen1_5_0_5b_chat resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen1.5-0.5b-chat model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen1.5-0.5b-chat model. - -```sql -INSERT INTO cloudflare.ai.qwen1_5_0_5b_chat ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen1_5_0_5b_chat - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen1_5_0_5b_chat resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen1_5_14b_chat_awq/index.md b/stackql_cloudflare/website/docs/services/ai/qwen1_5_14b_chat_awq/index.md deleted file mode 100644 index 533dd907777..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen1_5_14b_chat_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: qwen1_5_14b_chat_awq -hide_title: false -hide_table_of_contents: false -keywords: - - qwen1_5_14b_chat_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen1_5_14b_chat_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen1.5-14b-chat-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen1.5-14b-chat-awq model. - -```sql -INSERT INTO cloudflare.ai.qwen1_5_14b_chat_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen1_5_14b_chat_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen1_5_14b_chat_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen1_5_1_8b_chat/index.md b/stackql_cloudflare/website/docs/services/ai/qwen1_5_1_8b_chat/index.md deleted file mode 100644 index 1e1a133ba4f..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen1_5_1_8b_chat/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: qwen1_5_1_8b_chat -hide_title: false -hide_table_of_contents: false -keywords: - - qwen1_5_1_8b_chat - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen1_5_1_8b_chat resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen1.5-1.8b-chat model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen1.5-1.8b-chat model. - -```sql -INSERT INTO cloudflare.ai.qwen1_5_1_8b_chat ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen1_5_1_8b_chat - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen1_5_1_8b_chat resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen1_5_7b_chat_awq/index.md b/stackql_cloudflare/website/docs/services/ai/qwen1_5_7b_chat_awq/index.md deleted file mode 100644 index 744a60f3cac..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen1_5_7b_chat_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: qwen1_5_7b_chat_awq -hide_title: false -hide_table_of_contents: false -keywords: - - qwen1_5_7b_chat_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen1_5_7b_chat_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen1.5-7b-chat-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen1.5-7b-chat-awq model. - -```sql -INSERT INTO cloudflare.ai.qwen1_5_7b_chat_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen1_5_7b_chat_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen1_5_7b_chat_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen2_5_coder_32b_instruct/index.md b/stackql_cloudflare/website/docs/services/ai/qwen2_5_coder_32b_instruct/index.md deleted file mode 100644 index f47b469c6f5..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen2_5_coder_32b_instruct/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: qwen2_5_coder_32b_instruct -hide_title: false -hide_table_of_contents: false -keywords: - - qwen2_5_coder_32b_instruct - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen2_5_coder_32b_instruct resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen2.5-coder-32b-instruct model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen2.5-coder-32b-instruct model. - -```sql -INSERT INTO cloudflare.ai.qwen2_5_coder_32b_instruct ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen2_5_coder_32b_instruct - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen2_5_coder_32b_instruct resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen3_30b_a3b_fp8/index.md b/stackql_cloudflare/website/docs/services/ai/qwen3_30b_a3b_fp8/index.md deleted file mode 100644 index 7b6001d1edd..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen3_30b_a3b_fp8/index.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -title: qwen3_30b_a3b_fp8 -hide_title: false -hide_table_of_contents: false -keywords: - - qwen3_30b_a3b_fp8 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen3_30b_a3b_fp8 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen3-30b-a3b-fp8 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen3-30b-a3b-fp8 model. - -```sql -INSERT INTO cloudflare.ai.qwen3_30b_a3b_fp8 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -requests, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ requests }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen3_30b_a3b_fp8 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen3_30b_a3b_fp8 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 2000 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: requests - value: - - frequency_penalty: {{ frequency_penalty }} - lora: "{{ lora }}" - max_tokens: {{ max_tokens }} - presence_penalty: {{ presence_penalty }} - prompt: "{{ prompt }}" - raw: {{ raw }} - repetition_penalty: {{ repetition_penalty }} - response_format: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - seed: {{ seed }} - stream: {{ stream }} - temperature: {{ temperature }} - top_k: {{ top_k }} - top_p: {{ top_p }} - functions: "{{ functions }}" - messages: "{{ messages }}" - tools: "{{ tools }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwen3_embedding_0_6b/index.md b/stackql_cloudflare/website/docs/services/ai/qwen3_embedding_0_6b/index.md deleted file mode 100644 index cdd6afd1e75..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwen3_embedding_0_6b/index.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: qwen3_embedding_0_6b -hide_title: false -hide_table_of_contents: false -keywords: - - qwen3_embedding_0_6b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwen3_embedding_0_6b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwen3-embedding-0.6b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwen3-embedding-0.6b model. - -```sql -INSERT INTO cloudflare.ai.qwen3_embedding_0_6b ( -documents, -instruction, -queries, -text, -account_id, -queueRequest, -tags -) -SELECT -'{{ documents }}', -'{{ instruction }}', -'{{ queries }}', -'{{ text }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwen3_embedding_0_6b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwen3_embedding_0_6b resource. - - name: documents - value: "{{ documents }}" - description: | - A single document string - - name: instruction - value: "{{ instruction }}" - description: | - Optional instruction for the task - default: Given a web search query, retrieve relevant passages that answer the query - - name: queries - value: "{{ queries }}" - description: | - A single query string - - name: text - value: "{{ text }}" - description: | - Alias for documents: a single text string - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/qwq_32b/index.md b/stackql_cloudflare/website/docs/services/ai/qwq_32b/index.md deleted file mode 100644 index 5652d4be95d..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/qwq_32b/index.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -title: qwq_32b -hide_title: false -hide_table_of_contents: false -keywords: - - qwq_32b - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a qwq_32b resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/qwen/qwq-32b model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/qwen/qwq-32b model. - -```sql -INSERT INTO cloudflare.ai.qwq_32b ( -frequency_penalty, -guided_json, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ guided_json }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: qwq_32b - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the qwq_32b resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: guided_json - value: "{{ guided_json }}" - description: | - JSON schema that should be fulfilled for the response. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.15 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - tool_call_id: "{{ tool_call_id }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/reranking/index.md b/stackql_cloudflare/website/docs/services/ai/reranking/index.md new file mode 100644 index 00000000000..251822092b8 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/reranking/index.md @@ -0,0 +1,173 @@ +--- +title: reranking +hide_title: false +hide_table_of_contents: false +keywords: + - reranking + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a reranking resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Reranking (1 model) + +
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringRaw response payload (binary or non-object results), used by contents-mode families.
array
array
object
boolean
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +contents +FROM cloudflare.ai.reranking +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND query = '{{ query }}' -- model input +AND contexts = '{{ contexts }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/resnet_50/index.md b/stackql_cloudflare/website/docs/services/ai/resnet_50/index.md deleted file mode 100644 index d89ff1d6586..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/resnet_50/index.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: resnet_50 -hide_title: false -hide_table_of_contents: false -keywords: - - resnet_50 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a resnet_50 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/microsoft/resnet-50 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/microsoft/resnet-50 model. - -```sql -INSERT INTO cloudflare.ai.resnet_50 ( -account_id, -queueRequest, -tags -) -SELECT -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: resnet_50 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the resnet_50 resource. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/run/index.md b/stackql_cloudflare/website/docs/services/ai/run/index.md index 145c4488305..d597a3cb98a 100644 --- a/stackql_cloudflare/website/docs/services/ai/run/index.md +++ b/stackql_cloudflare/website/docs/services/ai/run/index.md @@ -28,12 +28,260 @@ Creates, updates, deletes, gets or lists a run resource. Id +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Text Generation (55 models) + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+Text Embeddings (12 models) + +
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+Speech to Text (3 models) + +
+
+
+ +
+ +
+Translation (3 models) + +
+
+
+ +
+ +
+Summarization (2 models) + +
+
+ +
+ +
+Text to Image (11 models) + +
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+Text to Speech (4 models) + +
+
+
+
+ +
+ +
+Text Classification (2 models) + +
+
+ +
+ +
+Reranking (1 model) + +
+ +
+ +The task-family resources above give these models typed result columns - prefer them over `run` where one exists. Binary-input models (`@cf/facebook/nonomni-detr-resnet-50`, `@cf/microsoft/nonomni-resnet-50`, `@cf/microsoft/resnet-50`, `@cf/openai/whisper`, `@cf/openai/whisper-tiny-en`) take a raw request body and are exposed as exec methods on this resource instead of SELECT. + +::: + ## Fields The following fields are returned by `SELECT` queries: -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayEmbedding vectors, one per input text.
stringEcho of the model name, where reported.
stringPooling method used (cls or mean), where applicable.
stringThe generated text response from the model.
arrayDimensions of the returned embedding matrix.
stringThe summarized text.
stringThe transcribed text.
arrayTool call requests emitted by the model, if tools were provided.
objectModel/language detail, where reported.
stringThe translated text.
objectToken usage counts (prompt_tokens, completion_tokens, total_tokens).
stringWebVTT formatted transcription, where reported.
numberNumber of words in the transcription, where reported.
arrayPer-word timing detail, where reported.
+ + ## Methods @@ -52,11 +300,46 @@ The following methods are available for this resource: - + account_id, model_name This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + + + + account_id + queueRequest, tags + Runs inference on the @cf/facebook/nonomni-detr-resnet-50 model. + + + + + account_id + queueRequest, tags + Runs inference on the @cf/microsoft/nonomni-resnet-50 model. + + + + + account_id + queueRequest, tags + Runs inference on the @cf/microsoft/resnet-50 model. + + + + + account_id + queueRequest, tags + Runs inference on the @cf/openai/whisper model. + + + + + account_id + queueRequest, tags + Runs inference on the @cf/openai/whisper-tiny-en model. + @@ -83,16 +366,25 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string + + + string + + + + + string + + -## `INSERT` examples +## `SELECT` examples @@ -100,258 +392,94 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). ```sql -INSERT INTO cloudflare.ai.run ( +SELECT +response, +usage, +data, +shape, text, -guidance, -height, -image, -image_b64, -mask, -negative_prompt, -num_steps, -prompt, -seed, -strength, -width, -lang, -audio, -source_lang, -target_lang, -frequency_penalty, -lora, -max_tokens, -presence_penalty, -raw, -repetition_penalty, -response_format, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -input_text, -max_length, -ignore_eos, -account_id, -model_name -) -SELECT -'{{ text }}', -{{ guidance }}, -{{ height }}, -'{{ image }}', -'{{ image_b64 }}', -'{{ mask }}', -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}', -{{ seed }}, -{{ strength }}, -{{ width }}, -'{{ lang }}', -'{{ audio }}', -'{{ source_lang }}', -'{{ target_lang }}', -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ input_text }}', -{{ max_length }}, -{{ ignore_eos }}, -'{{ account_id }}', -'{{ model_name }}' -RETURNING -result +translated_text, +summary +FROM cloudflare.ai.run +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND prompt = '{{ prompt }}' -- model input ; ``` - - -{`# Description fields are for documentation purposes -- name: run - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the run resource. - - name: model_name - value: "{{ model_name }}" - description: Required parameter for the run resource. - - name: text - value: "{{ text }}" - description: | - The text that you want to classify - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 7.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - - name: image - value: - - {{ image }} - description: | - For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - - name: image_b64 - value: "{{ image_b64 }}" - description: | - For use with img2img tasks. A base64-encoded string of the input image - - name: mask - value: - - {{ mask }} - description: | - An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Text describing elements to avoid in the generated image - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 20 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: strength - value: {{ strength }} - description: | - A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - default: 1 - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - - name: lang - value: "{{ lang }}" - description: | - The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified - default: en - - name: audio - value: - - {{ audio }} - description: | - An array of integers that represent the audio data constrained to 8-bit unsigned integer values - - name: source_lang - value: "{{ source_lang }}" - description: | - The language of the recorded audio - - name: target_lang - value: "{{ target_lang }}" - description: | - The language to translate the transcription into. Currently only English is supported. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: input_text - value: "{{ input_text }}" - description: | - The text that you want the model to summarize - - name: max_length - value: {{ max_length }} - description: | - The maximum length of the generated summary in tokens - default: 1024 - - name: ignore_eos - value: {{ ignore_eos }} - description: | - Whether to ignore the EOS token and continue generating tokens after the EOS token is generated. -`} + + +## Lifecycle Methods + + + + +Runs inference on the @cf/facebook/nonomni-detr-resnet-50 model. + +```sql +EXEC cloudflare.ai.run.nonomni_detr_resnet_50 +@account_id='{{ account_id }}' --required, +@queueRequest='{{ queueRequest }}', +@tags='{{ tags }}' +; +``` + + + +Runs inference on the @cf/microsoft/nonomni-resnet-50 model. + +```sql +EXEC cloudflare.ai.run.nonomni_resnet_50 +@account_id='{{ account_id }}' --required, +@queueRequest='{{ queueRequest }}', +@tags='{{ tags }}' +; +``` + + + +Runs inference on the @cf/microsoft/resnet-50 model. + +```sql +EXEC cloudflare.ai.run.resnet_50 +@account_id='{{ account_id }}' --required, +@queueRequest='{{ queueRequest }}', +@tags='{{ tags }}' +; +``` + + + +Runs inference on the @cf/openai/whisper model. + +```sql +EXEC cloudflare.ai.run.whisper +@account_id='{{ account_id }}' --required, +@queueRequest='{{ queueRequest }}', +@tags='{{ tags }}' +; +``` + + + +Runs inference on the @cf/openai/whisper-tiny-en model. + +```sql +EXEC cloudflare.ai.run.whisper_tiny_en +@account_id='{{ account_id }}' --required, +@queueRequest='{{ queueRequest }}', +@tags='{{ tags }}' +; +``` diff --git a/stackql_cloudflare/website/docs/services/ai/search/index.md b/stackql_cloudflare/website/docs/services/ai/search/index.md index 1ee3ddbe4c5..1dc9a1c1ee2 100644 --- a/stackql_cloudflare/website/docs/services/ai/search/index.md +++ b/stackql_cloudflare/website/docs/services/ai/search/index.md @@ -32,8 +32,39 @@ Creates, updates, deletes, gets or lists a search resource. The following fields are returned by `SELECT` queries: -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + + +Returns the log details + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
boolean
+ + ## Methods @@ -52,8 +83,8 @@ The following methods are available for this resource: - - id, account_id, query + + id, account_id @@ -86,83 +117,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# -## `INSERT` examples +## `SELECT` examples -No description available. +Returns the log details ```sql -INSERT INTO cloudflare.ai.search ( -filters, -max_num_results, -query, -ranking_options, -reranking, -rewrite_query, -id, -account_id -) -SELECT -'{{ filters }}', -{{ max_num_results }}, -'{{ query }}' /* required */, -'{{ ranking_options }}', -'{{ reranking }}', -{{ rewrite_query }}, -'{{ id }}', -'{{ account_id }}' -RETURNING +SELECT result, success +FROM cloudflare.ai.search +WHERE id = '{{ id }}' -- required +AND account_id = '{{ account_id }}' -- required ; ``` - - - -{`# Description fields are for documentation purposes -- name: search - props: - - name: id - value: "{{ id }}" - description: Required parameter for the search resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the search resource. - - name: filters - value: - key: "{{ key }}" - type: "{{ type }}" - value: "{{ value }}" - filters: - - key: "{{ key }}" - type: "{{ type }}" - value: "{{ value }}" - - name: max_num_results - value: {{ max_num_results }} - default: 10 - - name: query - value: "{{ query }}" - - name: ranking_options - value: - ranker: "{{ ranker }}" - score_threshold: {{ score_threshold }} - default: [object Object] - - name: reranking - value: - enabled: {{ enabled }} - model: "{{ model }}" - - name: rewrite_query - value: {{ rewrite_query }} - default: false -`} - diff --git a/stackql_cloudflare/website/docs/services/ai/speech_to_text/index.md b/stackql_cloudflare/website/docs/services/ai/speech_to_text/index.md new file mode 100644 index 00000000000..da33f991b5d --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/speech_to_text/index.md @@ -0,0 +1,223 @@ +--- +title: speech_to_text +hide_title: false +hide_table_of_contents: false +keywords: + - speech_to_text + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a speech_to_text resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Speech to Text (3 models) + +
+
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayEmbedding vectors, one per input text.
stringEcho of the model name, where reported.
stringPooling method used (cls or mean), where applicable.
stringThe generated text response from the model.
arrayDimensions of the returned embedding matrix.
stringThe summarized text.
stringThe transcribed text.
arrayTool call requests emitted by the model, if tools were provided.
objectModel/language detail, where reported.
stringThe translated text.
objectToken usage counts (prompt_tokens, completion_tokens, total_tokens).
stringWebVTT formatted transcription, where reported.
numberNumber of words in the transcription, where reported.
arrayPer-word timing detail, where reported.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +text, +word_count, +words, +vtt, +transcription_info +FROM cloudflare.ai.speech_to_text +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND audio = '{{ audio }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/sqlcoder_7b_2/index.md b/stackql_cloudflare/website/docs/services/ai/sqlcoder_7b_2/index.md deleted file mode 100644 index 70189814aa0..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/sqlcoder_7b_2/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: sqlcoder_7b_2 -hide_title: false -hide_table_of_contents: false -keywords: - - sqlcoder_7b_2 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a sqlcoder_7b_2 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/defog/sqlcoder-7b-2 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/defog/sqlcoder-7b-2 model. - -```sql -INSERT INTO cloudflare.ai.sqlcoder_7b_2 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: sqlcoder_7b_2 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the sqlcoder_7b_2 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_v1_5_img2img/index.md b/stackql_cloudflare/website/docs/services/ai/stable_diffusion_v1_5_img2img/index.md deleted file mode 100644 index cf8e70b30af..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_v1_5_img2img/index.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: stable_diffusion_v1_5_img2img -hide_title: false -hide_table_of_contents: false -keywords: - - stable_diffusion_v1_5_img2img - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a stable_diffusion_v1_5_img2img resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/runwayml/stable-diffusion-v1-5-img2img model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/runwayml/stable-diffusion-v1-5-img2img model. - -```sql -INSERT INTO cloudflare.ai.stable_diffusion_v1_5_img2img ( -guidance, -height, -image, -image_b64, -mask, -negative_prompt, -num_steps, -prompt, -seed, -strength, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -'{{ image }}', -'{{ image_b64 }}', -'{{ mask }}', -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ strength }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: stable_diffusion_v1_5_img2img - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the stable_diffusion_v1_5_img2img resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 7.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - - name: image - value: - - {{ image }} - description: | - For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - - name: image_b64 - value: "{{ image_b64 }}" - description: | - For use with img2img tasks. A base64-encoded string of the input image - - name: mask - value: - - {{ mask }} - description: | - An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Text describing elements to avoid in the generated image - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 20 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: strength - value: {{ strength }} - description: | - A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - default: 1 - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_v1_5_inpainting/index.md b/stackql_cloudflare/website/docs/services/ai/stable_diffusion_v1_5_inpainting/index.md deleted file mode 100644 index b0ceb63001b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_v1_5_inpainting/index.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: stable_diffusion_v1_5_inpainting -hide_title: false -hide_table_of_contents: false -keywords: - - stable_diffusion_v1_5_inpainting - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a stable_diffusion_v1_5_inpainting resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/runwayml/stable-diffusion-v1-5-inpainting model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/runwayml/stable-diffusion-v1-5-inpainting model. - -```sql -INSERT INTO cloudflare.ai.stable_diffusion_v1_5_inpainting ( -guidance, -height, -image, -image_b64, -mask, -negative_prompt, -num_steps, -prompt, -seed, -strength, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -'{{ image }}', -'{{ image_b64 }}', -'{{ mask }}', -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ strength }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: stable_diffusion_v1_5_inpainting - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the stable_diffusion_v1_5_inpainting resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 7.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - - name: image - value: - - {{ image }} - description: | - For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - - name: image_b64 - value: "{{ image_b64 }}" - description: | - For use with img2img tasks. A base64-encoded string of the input image - - name: mask - value: - - {{ mask }} - description: | - An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Text describing elements to avoid in the generated image - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 20 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: strength - value: {{ strength }} - description: | - A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - default: 1 - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_xl_base_1_0/index.md b/stackql_cloudflare/website/docs/services/ai/stable_diffusion_xl_base_1_0/index.md deleted file mode 100644 index faaf8af81b4..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_xl_base_1_0/index.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: stable_diffusion_xl_base_1_0 -hide_title: false -hide_table_of_contents: false -keywords: - - stable_diffusion_xl_base_1_0 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a stable_diffusion_xl_base_1_0 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/stabilityai/stable-diffusion-xl-base-1.0 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/stabilityai/stable-diffusion-xl-base-1.0 model. - -```sql -INSERT INTO cloudflare.ai.stable_diffusion_xl_base_1_0 ( -guidance, -height, -image, -image_b64, -mask, -negative_prompt, -num_steps, -prompt, -seed, -strength, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -'{{ image }}', -'{{ image_b64 }}', -'{{ mask }}', -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ strength }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: stable_diffusion_xl_base_1_0 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the stable_diffusion_xl_base_1_0 resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 7.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - - name: image - value: - - {{ image }} - description: | - For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - - name: image_b64 - value: "{{ image_b64 }}" - description: | - For use with img2img tasks. A base64-encoded string of the input image - - name: mask - value: - - {{ mask }} - description: | - An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Text describing elements to avoid in the generated image - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 20 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: strength - value: {{ strength }} - description: | - A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - default: 1 - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_xl_lightning/index.md b/stackql_cloudflare/website/docs/services/ai/stable_diffusion_xl_lightning/index.md deleted file mode 100644 index c44051d83a3..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/stable_diffusion_xl_lightning/index.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: stable_diffusion_xl_lightning -hide_title: false -hide_table_of_contents: false -keywords: - - stable_diffusion_xl_lightning - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a stable_diffusion_xl_lightning resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, promptqueueRequest, tagsRuns inference on the @cf/bytedance/stable-diffusion-xl-lightning model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/bytedance/stable-diffusion-xl-lightning model. - -```sql -INSERT INTO cloudflare.ai.stable_diffusion_xl_lightning ( -guidance, -height, -image, -image_b64, -mask, -negative_prompt, -num_steps, -prompt, -seed, -strength, -width, -account_id, -queueRequest, -tags -) -SELECT -{{ guidance }}, -{{ height }}, -'{{ image }}', -'{{ image_b64 }}', -'{{ mask }}', -'{{ negative_prompt }}', -{{ num_steps }}, -'{{ prompt }}' /* required */, -{{ seed }}, -{{ strength }}, -{{ width }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: stable_diffusion_xl_lightning - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the stable_diffusion_xl_lightning resource. - - name: guidance - value: {{ guidance }} - description: | - Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt - default: 7.5 - - name: height - value: {{ height }} - description: | - The height of the generated image in pixels - - name: image - value: - - {{ image }} - description: | - For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values - - name: image_b64 - value: "{{ image_b64 }}" - description: | - For use with img2img tasks. A base64-encoded string of the input image - - name: mask - value: - - {{ mask }} - description: | - An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values - - name: negative_prompt - value: "{{ negative_prompt }}" - description: | - Text describing elements to avoid in the generated image - - name: num_steps - value: {{ num_steps }} - description: | - The number of diffusion steps; higher values can improve quality but take longer - default: 20 - - name: prompt - value: "{{ prompt }}" - description: | - A text description of the image you want to generate - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the image generation - - name: strength - value: {{ strength }} - description: | - A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image - default: 1 - - name: width - value: {{ width }} - description: | - The width of the generated image in pixels - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/starling_lm_7b_beta/index.md b/stackql_cloudflare/website/docs/services/ai/starling_lm_7b_beta/index.md deleted file mode 100644 index 19efaa6ef00..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/starling_lm_7b_beta/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: starling_lm_7b_beta -hide_title: false -hide_table_of_contents: false -keywords: - - starling_lm_7b_beta - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a starling_lm_7b_beta resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/nexusflow/starling-lm-7b-beta model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/nexusflow/starling-lm-7b-beta model. - -```sql -INSERT INTO cloudflare.ai.starling_lm_7b_beta ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: starling_lm_7b_beta - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the starling_lm_7b_beta resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/summarization/index.md b/stackql_cloudflare/website/docs/services/ai/summarization/index.md new file mode 100644 index 00000000000..782486892bd --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/summarization/index.md @@ -0,0 +1,218 @@ +--- +title: summarization +hide_title: false +hide_table_of_contents: false +keywords: + - summarization + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a summarization resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Summarization (2 models) + +
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayEmbedding vectors, one per input text.
stringEcho of the model name, where reported.
stringPooling method used (cls or mean), where applicable.
stringThe generated text response from the model.
arrayDimensions of the returned embedding matrix.
stringThe summarized text.
stringThe transcribed text.
arrayTool call requests emitted by the model, if tools were provided.
objectModel/language detail, where reported.
stringThe translated text.
objectToken usage counts (prompt_tokens, completion_tokens, total_tokens).
stringWebVTT formatted transcription, where reported.
numberNumber of words in the transcription, where reported.
arrayPer-word timing detail, where reported.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +summary +FROM cloudflare.ai.summarization +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND input_text = '{{ input_text }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/tasks/index.md b/stackql_cloudflare/website/docs/services/ai/tasks/index.md index 039f5250441..428f806c663 100644 --- a/stackql_cloudflare/website/docs/services/ai/tasks/index.md +++ b/stackql_cloudflare/website/docs/services/ai/tasks/index.md @@ -51,6 +51,21 @@ Returns a list of tasks + + + string + Task identifier (UUID). + + + + string + Task name, e.g. Text Generation. + + + + string + + @@ -116,7 +131,9 @@ Searches Workers AI models by task type (e.g., text-generation, embeddings). ```sql SELECT -* +id, +name, +description FROM cloudflare.ai.tasks WHERE account_id = '{{ account_id }}' -- required ; diff --git a/stackql_cloudflare/website/docs/services/ai/text_classification/index.md b/stackql_cloudflare/website/docs/services/ai/text_classification/index.md new file mode 100644 index 00000000000..dc9b9c0f987 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/text_classification/index.md @@ -0,0 +1,173 @@ +--- +title: text_classification +hide_title: false +hide_table_of_contents: false +keywords: + - text_classification + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a text_classification resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Text Classification (2 models) + +
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringRaw response payload (binary or non-object results), used by contents-mode families.
array
array
object
boolean
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +contents +FROM cloudflare.ai.text_classification +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND text = '{{ text }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/text_embeddings/index.md b/stackql_cloudflare/website/docs/services/ai/text_embeddings/index.md new file mode 100644 index 00000000000..d076264ed28 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/text_embeddings/index.md @@ -0,0 +1,230 @@ +--- +title: text_embeddings +hide_title: false +hide_table_of_contents: false +keywords: + - text_embeddings + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a text_embeddings resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Text Embeddings (12 models) + +
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayEmbedding vectors, one per input text.
stringEcho of the model name, where reported.
stringPooling method used (cls or mean), where applicable.
stringThe generated text response from the model.
arrayDimensions of the returned embedding matrix.
stringThe summarized text.
stringThe transcribed text.
arrayTool call requests emitted by the model, if tools were provided.
objectModel/language detail, where reported.
stringThe translated text.
objectToken usage counts (prompt_tokens, completion_tokens, total_tokens).
stringWebVTT formatted transcription, where reported.
numberNumber of words in the transcription, where reported.
arrayPer-word timing detail, where reported.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +shape, +data, +pooling +FROM cloudflare.ai.text_embeddings +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND text = '{{ text }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/text_generation/index.md b/stackql_cloudflare/website/docs/services/ai/text_generation/index.md new file mode 100644 index 00000000000..74dc38fd01d --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/text_generation/index.md @@ -0,0 +1,273 @@ +--- +title: text_generation +hide_title: false +hide_table_of_contents: false +keywords: + - text_generation + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a text_generation resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Text Generation (55 models) + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayEmbedding vectors, one per input text.
stringEcho of the model name, where reported.
stringPooling method used (cls or mean), where applicable.
stringThe generated text response from the model.
arrayDimensions of the returned embedding matrix.
stringThe summarized text.
stringThe transcribed text.
arrayTool call requests emitted by the model, if tools were provided.
objectModel/language detail, where reported.
stringThe translated text.
objectToken usage counts (prompt_tokens, completion_tokens, total_tokens).
stringWebVTT formatted transcription, where reported.
numberNumber of words in the transcription, where reported.
arrayPer-word timing detail, where reported.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +response, +usage, +tool_calls +FROM cloudflare.ai.text_generation +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND prompt = '{{ prompt }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/text_to_image/index.md b/stackql_cloudflare/website/docs/services/ai/text_to_image/index.md new file mode 100644 index 00000000000..a601ebeac10 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/text_to_image/index.md @@ -0,0 +1,182 @@ +--- +title: text_to_image +hide_title: false +hide_table_of_contents: false +keywords: + - text_to_image + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a text_to_image resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Text to Image (11 models) + +
+
+
+
+
+
+
+
+
+
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringRaw response payload (binary or non-object results), used by contents-mode families.
array
array
object
boolean
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +contents +FROM cloudflare.ai.text_to_image +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND prompt = '{{ prompt }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/text_to_speech/index.md b/stackql_cloudflare/website/docs/services/ai/text_to_speech/index.md new file mode 100644 index 00000000000..5eb4f5a6572 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/text_to_speech/index.md @@ -0,0 +1,175 @@ +--- +title: text_to_speech +hide_title: false +hide_table_of_contents: false +keywords: + - text_to_speech + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a text_to_speech resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Text to Speech (4 models) + +
+
+
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringRaw response payload (binary or non-object results), used by contents-mode families.
array
array
object
boolean
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +contents +FROM cloudflare.ai.text_to_speech +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND text = '{{ text }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/tinyllama_1_1b_chat_v1_0/index.md b/stackql_cloudflare/website/docs/services/ai/tinyllama_1_1b_chat_v1_0/index.md deleted file mode 100644 index 686d900080c..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/tinyllama_1_1b_chat_v1_0/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: tinyllama_1_1b_chat_v1_0 -hide_title: false -hide_table_of_contents: false -keywords: - - tinyllama_1_1b_chat_v1_0 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a tinyllama_1_1b_chat_v1_0 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model. - -```sql -INSERT INTO cloudflare.ai.tinyllama_1_1b_chat_v1_0 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: tinyllama_1_1b_chat_v1_0 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the tinyllama_1_1b_chat_v1_0 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/to_markdown/index.md b/stackql_cloudflare/website/docs/services/ai/to_markdown/index.md index f476e15456f..ee2032f1d53 100644 --- a/stackql_cloudflare/website/docs/services/ai/to_markdown/index.md +++ b/stackql_cloudflare/website/docs/services/ai/to_markdown/index.md @@ -33,12 +33,14 @@ Creates, updates, deletes, gets or lists a to_markdown resource. The following fields are returned by `SELECT` queries: - + + +Model Schema @@ -50,13 +52,13 @@ The following fields are returned by `SELECT` queries: - - + + - - + + @@ -80,11 +82,11 @@ The following methods are available for this resource: - + - +
stringarray
stringboolean
account_id Lists all file formats supported for conversion to Markdown.Converts uploaded files into Markdown format using Workers AI.
@@ -113,19 +115,19 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# ## `SELECT` examples - + -Lists all file formats supported for conversion to Markdown. +Converts uploaded files into Markdown format using Workers AI. ```sql SELECT -extension, -mimeType +result, +success FROM cloudflare.ai.to_markdown WHERE account_id = '{{ account_id }}' -- required ; diff --git a/stackql_cloudflare/website/docs/services/cloudforce_one/relate_create/index.md b/stackql_cloudflare/website/docs/services/ai/to_markdown_supported/index.md similarity index 56% rename from stackql_cloudflare/website/docs/services/cloudforce_one/relate_create/index.md rename to stackql_cloudflare/website/docs/services/ai/to_markdown_supported/index.md index 39e6b2762be..10784496950 100644 --- a/stackql_cloudflare/website/docs/services/cloudforce_one/relate_create/index.md +++ b/stackql_cloudflare/website/docs/services/ai/to_markdown_supported/index.md @@ -1,10 +1,10 @@ --- -title: relate_create +title: to_markdown_supported hide_title: false hide_table_of_contents: false keywords: - - relate_create - - cloudforce_one + - to_markdown_supported + - ai - cloudflare - infrastructure-as-code - configuration-as-data @@ -19,21 +19,50 @@ import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a relate_create resource. +Creates, updates, deletes, gets or lists a to_markdown_supported resource. ## Overview - + - +
Name
Name
TypeResource
Id
Id
## Fields The following fields are returned by `SELECT` queries: -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
+ + ## Methods @@ -51,11 +80,11 @@ The following methods are available for this resource: - - - account_id, event_id, events - + + + account_id + Lists all file formats supported for conversion to Markdown. @@ -78,34 +107,27 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The Cloudflare account ID. - - - string - The event ID. - -## Lifecycle Methods +## `SELECT` examples - + -Returns success if operation succeeded. +Lists all file formats supported for conversion to Markdown. ```sql -EXEC cloudflare.cloudforce_one.relate_create.create_by_account -@account_id='{{ account_id }}' --required, -@event_id='{{ event_id }}' --required -@@json= -'{ -"events": "{{ events }}" -}' +SELECT +extension, +mimeType +FROM cloudflare.ai.to_markdown_supported +WHERE account_id = '{{ account_id }}' -- required ; ``` diff --git a/stackql_cloudflare/website/docs/services/ai/tomarkdown/index.md b/stackql_cloudflare/website/docs/services/ai/tomarkdown/index.md deleted file mode 100644 index 4f0439a97d5..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/tomarkdown/index.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: tomarkdown -hide_title: false -hide_table_of_contents: false -keywords: - - tomarkdown - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a tomarkdown resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, filesConverts uploaded files into Markdown format using Workers AI.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
- -## `INSERT` examples - - - - -Converts uploaded files into Markdown format using Workers AI. - -```sql -INSERT INTO cloudflare.ai.tomarkdown ( -files, -account_id -) -SELECT -'{{ files }}' /* required */, -'{{ account_id }}' -RETURNING -result, -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: tomarkdown - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the tomarkdown resource. - - name: files - value: - - "{{ files }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/translation/index.md b/stackql_cloudflare/website/docs/services/ai/translation/index.md new file mode 100644 index 00000000000..8344bebd631 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai/translation/index.md @@ -0,0 +1,220 @@ +--- +title: translation +hide_title: false +hide_table_of_contents: false +keywords: + - translation + - ai + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a translation resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +
+ +:::info[Supported models] + +Set `model_name` to one of the following models: + +
+Translation (3 models) + +
+
+
+ +
+ +::: + +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Model response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayEmbedding vectors, one per input text.
stringEcho of the model name, where reported.
stringPooling method used (cls or mean), where applicable.
stringThe generated text response from the model.
arrayDimensions of the returned embedding matrix.
stringThe summarized text.
stringThe transcribed text.
arrayTool call requests emitted by the model, if tools were provided.
objectModel/language detail, where reported.
stringThe translated text.
objectToken usage counts (prompt_tokens, completion_tokens, total_tokens).
stringWebVTT formatted transcription, where reported.
numberNumber of words in the transcription, where reported.
arrayPer-word timing detail, where reported.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, model_nameThis endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
string
+ +## `SELECT` examples + + + + +This endpoint provides users with the capability to run specific AI models on-demand. By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases. Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/). + +```sql +SELECT +translated_text +FROM cloudflare.ai.translation +WHERE account_id = '{{ account_id }}' -- required +AND model_name = '{{ model_name }}' -- required +AND text = '{{ text }}' -- model input +AND target_lang = '{{ target_lang }}' -- model input +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai/una_cybertron_7b_v2_bf16/index.md b/stackql_cloudflare/website/docs/services/ai/una_cybertron_7b_v2_bf16/index.md deleted file mode 100644 index 6f976444ad3..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/una_cybertron_7b_v2_bf16/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: una_cybertron_7b_v2_bf16 -hide_title: false -hide_table_of_contents: false -keywords: - - una_cybertron_7b_v2_bf16 - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an una_cybertron_7b_v2_bf16 resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/fblgit/una-cybertron-7b-v2-bf16 model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/fblgit/una-cybertron-7b-v2-bf16 model. - -```sql -INSERT INTO cloudflare.ai.una_cybertron_7b_v2_bf16 ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: una_cybertron_7b_v2_bf16 - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the una_cybertron_7b_v2_bf16 resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/whisper/index.md b/stackql_cloudflare/website/docs/services/ai/whisper/index.md deleted file mode 100644 index 83c3f8c4690..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/whisper/index.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: whisper -hide_title: false -hide_table_of_contents: false -keywords: - - whisper - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a whisper resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/openai/whisper model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/openai/whisper model. - -```sql -INSERT INTO cloudflare.ai.whisper ( -account_id, -queueRequest, -tags -) -SELECT -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: whisper - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the whisper resource. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/whisper_large_v3_turbo/index.md b/stackql_cloudflare/website/docs/services/ai/whisper_large_v3_turbo/index.md deleted file mode 100644 index d6a9914a53c..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/whisper_large_v3_turbo/index.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: whisper_large_v3_turbo -hide_title: false -hide_table_of_contents: false -keywords: - - whisper_large_v3_turbo - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a whisper_large_v3_turbo resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, audioqueueRequest, tagsRuns inference on the @cf/openai/whisper-large-v3-turbo model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/openai/whisper-large-v3-turbo model. - -```sql -INSERT INTO cloudflare.ai.whisper_large_v3_turbo ( -audio, -beam_size, -compression_ratio_threshold, -condition_on_previous_text, -hallucination_silence_threshold, -initial_prompt, -language, -log_prob_threshold, -no_speech_threshold, -prefix, -task, -vad_filter, -account_id, -queueRequest, -tags -) -SELECT -'{{ audio }}' /* required */, -{{ beam_size }}, -{{ compression_ratio_threshold }}, -{{ condition_on_previous_text }}, -{{ hallucination_silence_threshold }}, -'{{ initial_prompt }}', -'{{ language }}', -{{ log_prob_threshold }}, -{{ no_speech_threshold }}, -'{{ prefix }}', -'{{ task }}', -{{ vad_filter }}, -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: whisper_large_v3_turbo - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the whisper_large_v3_turbo resource. - - name: audio - value: "{{ audio }}" - description: | - Base64 encoded value of the audio data. - - name: beam_size - value: {{ beam_size }} - description: | - The number of beams to use in beam search decoding. Higher values may improve accuracy at the cost of speed. - default: 5 - - name: compression_ratio_threshold - value: {{ compression_ratio_threshold }} - description: | - Threshold for filtering out segments with high compression ratio, which often indicate repetitive or hallucinated text. - default: 2.4 - - name: condition_on_previous_text - value: {{ condition_on_previous_text }} - description: | - Whether to condition on previous text during transcription. Setting to false may help prevent hallucination loops. - default: true - - name: hallucination_silence_threshold - value: {{ hallucination_silence_threshold }} - description: | - Optional threshold (in seconds) to skip silent periods that may cause hallucinations. - - name: initial_prompt - value: "{{ initial_prompt }}" - description: | - A text prompt to help provide context to the model on the contents of the audio. - - name: language - value: "{{ language }}" - description: | - The language of the audio being transcribed or translated. - - name: log_prob_threshold - value: {{ log_prob_threshold }} - description: | - Threshold for filtering out segments with low average log probability, indicating low confidence. - default: -1 - - name: no_speech_threshold - value: {{ no_speech_threshold }} - description: | - Threshold for detecting no-speech segments. Segments with no-speech probability above this value are skipped. - default: 0.6 - - name: prefix - value: "{{ prefix }}" - description: | - The prefix appended to the beginning of the output of the transcription and can guide the transcription result. - - name: task - value: "{{ task }}" - description: | - Supported tasks are 'translate' or 'transcribe'. - default: transcribe - - name: vad_filter - value: {{ vad_filter }} - description: | - Preprocess the audio with a voice activity detection model. - default: false - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/whisper_tiny_en/index.md b/stackql_cloudflare/website/docs/services/ai/whisper_tiny_en/index.md deleted file mode 100644 index 4efb651c0bb..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/whisper_tiny_en/index.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: whisper_tiny_en -hide_title: false -hide_table_of_contents: false -keywords: - - whisper_tiny_en - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a whisper_tiny_en resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @cf/openai/whisper-tiny-en model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @cf/openai/whisper-tiny-en model. - -```sql -INSERT INTO cloudflare.ai.whisper_tiny_en ( -account_id, -queueRequest, -tags -) -SELECT -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: whisper_tiny_en - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the whisper_tiny_en resource. - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai/zephyr_7b_beta_awq/index.md b/stackql_cloudflare/website/docs/services/ai/zephyr_7b_beta_awq/index.md deleted file mode 100644 index 818decd621b..00000000000 --- a/stackql_cloudflare/website/docs/services/ai/zephyr_7b_beta_awq/index.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: zephyr_7b_beta_awq -hide_title: false -hide_table_of_contents: false -keywords: - - zephyr_7b_beta_awq - - ai - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a zephyr_7b_beta_awq resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idqueueRequest, tagsRuns inference on the @hf/thebloke/zephyr-7b-beta-awq model.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
string
string
- -## `INSERT` examples - - - - -Runs inference on the @hf/thebloke/zephyr-7b-beta-awq model. - -```sql -INSERT INTO cloudflare.ai.zephyr_7b_beta_awq ( -frequency_penalty, -lora, -max_tokens, -presence_penalty, -prompt, -raw, -repetition_penalty, -response_format, -seed, -stream, -temperature, -top_k, -top_p, -functions, -messages, -tools, -account_id, -queueRequest, -tags -) -SELECT -{{ frequency_penalty }}, -'{{ lora }}', -{{ max_tokens }}, -{{ presence_penalty }}, -'{{ prompt }}', -{{ raw }}, -{{ repetition_penalty }}, -'{{ response_format }}', -{{ seed }}, -{{ stream }}, -{{ temperature }}, -{{ top_k }}, -{{ top_p }}, -'{{ functions }}', -'{{ messages }}', -'{{ tools }}', -'{{ account_id }}', -'{{ queueRequest }}', -'{{ tags }}' -; -``` - - - -{`# Description fields are for documentation purposes -- name: zephyr_7b_beta_awq - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the zephyr_7b_beta_awq resource. - - name: frequency_penalty - value: {{ frequency_penalty }} - description: | - Decreases the likelihood of the model repeating the same lines verbatim. - - name: lora - value: "{{ lora }}" - description: | - Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. - - name: max_tokens - value: {{ max_tokens }} - description: | - The maximum number of tokens to generate in the response. - default: 256 - - name: presence_penalty - value: {{ presence_penalty }} - description: | - Increases the likelihood of the model introducing new topics. - - name: prompt - value: "{{ prompt }}" - description: | - The input text prompt for the model to generate a response. - - name: raw - value: {{ raw }} - description: | - If true, a chat template is not applied and you must adhere to the specific model's expected formatting. - default: false - - name: repetition_penalty - value: {{ repetition_penalty }} - description: | - Penalty for repeated tokens; higher values discourage repetition. - - name: response_format - value: - json_schema: "{{ json_schema }}" - type: "{{ type }}" - - name: seed - value: {{ seed }} - description: | - Random seed for reproducibility of the generation. - - name: stream - value: {{ stream }} - description: | - If true, the response will be streamed back incrementally using SSE, Server Sent Events. - default: false - - name: temperature - value: {{ temperature }} - description: | - Controls the randomness of the output; higher values produce more random results. - default: 0.6 - - name: top_k - value: {{ top_k }} - description: | - Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. - - name: top_p - value: {{ top_p }} - description: | - Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. - - name: functions - value: - - code: "{{ code }}" - name: "{{ name }}" - - name: messages - description: | - An array of message objects representing the conversation history. - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: tools - description: | - A list of tools available for the assistant to use. - value: - - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - function: - description: "{{ description }}" - name: "{{ name }}" - parameters: - properties: "{{ properties }}" - required: - - "{{ required }}" - type: "{{ type }}" - type: "{{ type }}" - - name: queueRequest - value: "{{ queueRequest }}" - - name: tags - value: "{{ tags }}" -`} - - - diff --git a/stackql_cloudflare/website/docs/services/ai_gateway/dynamic_routing/index.md b/stackql_cloudflare/website/docs/services/ai_gateway/dynamic_routing/index.md index f5d862c2bec..f9ec7923cb8 100644 --- a/stackql_cloudflare/website/docs/services/ai_gateway/dynamic_routing/index.md +++ b/stackql_cloudflare/website/docs/services/ai_gateway/dynamic_routing/index.md @@ -49,6 +49,51 @@ The following fields are returned by `SELECT` queries: + + + string + + + + + string + + + + + string + + + + + string + + + + + string (date-time) + + + + + object + + + + + array + + + + + string (date-time) + + + + + object + + @@ -145,7 +190,15 @@ List all AI Gateway Dynamic Routes. ```sql SELECT -* +id, +name, +gateway_id, +account_tag, +created_at, +deployment, +elements, +modified_at, +version FROM cloudflare.ai_gateway.dynamic_routing WHERE account_id = '{{ account_id }}' -- required AND gateway_id = '{{ gateway_id }}' -- required diff --git a/stackql_cloudflare/website/docs/services/ai_search/chat_completions/index.md b/stackql_cloudflare/website/docs/services/ai_search/chat_completions/index.md new file mode 100644 index 00000000000..c5f648c28c6 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai_search/chat_completions/index.md @@ -0,0 +1,238 @@ +--- +title: chat_completions +hide_title: false +hide_table_of_contents: false +keywords: + - chat_completions + - ai_search + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a chat_completions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Returns the chat completions results with retrieved files. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
array
string
string
+ + + +Returns the chat completion result with merged chunks from all instances. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
array
array
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_idPerforms a chat completion request against an AI Search instance, using indexed content as context for generating responses.
account_id, namePerforms a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
stringResource name.
+ +## `SELECT` examples + + + + +Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. + +```sql +SELECT +id, +choices, +chunks, +model, +object +FROM cloudflare.ai_search.chat_completions +WHERE id = '{{ id }}' -- required +AND account_id = '{{ account_id }}' -- required +; +``` + + + +Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response. + +```sql +SELECT +id, +choices, +chunks, +errors, +model, +object +FROM cloudflare.ai_search.chat_completions +WHERE account_id = '{{ account_id }}' -- required +AND name = '{{ name }}' -- required +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/ai_search/index.md b/stackql_cloudflare/website/docs/services/ai_search/index.md new file mode 100644 index 00000000000..805fa455954 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai_search/index.md @@ -0,0 +1,51 @@ +--- +title: ai_search +hide_title: false +hide_table_of_contents: false +keywords: + - ai_search + - cloudflare + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +ai_search service documentation. + +:::info[Service Summary] + +total resources: __20__ + +::: + +## Resources +
+
+chat_completions
+instances
+instances_items
+instances_search
+instances_stats
+item_chunks
+item_logs
+items
+items_download
+jobs +
+
+jobs_logs
+namespace_instance_chat_completions
+namespace_instances
+namespaces
+namespaces_instance_job_logs
+namespaces_instance_jobs
+namespaces_instance_search
+namespaces_instance_stats
+namespaces_search
+tokens +
+
\ No newline at end of file diff --git a/stackql_cloudflare/website/docs/services/aisearch/instances/index.md b/stackql_cloudflare/website/docs/services/ai_search/instances/index.md similarity index 98% rename from stackql_cloudflare/website/docs/services/aisearch/instances/index.md rename to stackql_cloudflare/website/docs/services/ai_search/instances/index.md index 10e90926cd0..fddd6a4cdfe 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/instances/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/instances/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - instances - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an instances resource. - +
Name
TypeResource
Id
Id
## Fields @@ -627,7 +627,7 @@ source_params, status, sync_interval, type -FROM cloudflare.aisearch.instances +FROM cloudflare.ai_search.instances WHERE account_id = '{{ account_id }}' -- required AND id = '{{ id }}' -- required ; @@ -677,7 +677,7 @@ source_params, status, sync_interval, type -FROM cloudflare.aisearch.instances +FROM cloudflare.ai_search.instances WHERE account_id = '{{ account_id }}' -- required AND page = '{{ page }}' AND per_page = '{{ per_page }}' @@ -705,7 +705,7 @@ AND order_by_direction = '{{ order_by_direction }}' Create a new instance. ```sql -INSERT INTO cloudflare.aisearch.instances ( +INSERT INTO cloudflare.ai_search.instances ( ai_gateway_id, ai_search_model, cache, @@ -939,7 +939,7 @@ success Update instance. ```sql -REPLACE cloudflare.aisearch.instances +REPLACE cloudflare.ai_search.instances SET ai_gateway_id = '{{ ai_gateway_id }}', ai_search_model = '{{ ai_search_model }}', @@ -995,7 +995,7 @@ success; Delete instance. ```sql -DELETE FROM cloudflare.aisearch.instances +DELETE FROM cloudflare.ai_search.instances WHERE account_id = '{{ account_id }}' --required AND id = '{{ id }}' --required ; @@ -1017,7 +1017,7 @@ AND id = '{{ id }}' --required Moves an instance from its current namespace to the specified target namespace. Use 'default' as new_namespace to move the instance back to the default namespace. Fails with 400 if the target namespace already has an instance with the same id (ids must be unique within a namespace — the same id can exist in different namespaces). ```sql -EXEC cloudflare.aisearch.instances.ai_search_move_instance +EXEC cloudflare.ai_search.instances.ai_search_move_instance @account_id='{{ account_id }}' --required, @name='{{ name }}' --required, @id='{{ id }}' --required diff --git a/stackql_cloudflare/website/docs/services/aisearch/instances_items/index.md b/stackql_cloudflare/website/docs/services/ai_search/instances_items/index.md similarity index 97% rename from stackql_cloudflare/website/docs/services/aisearch/instances_items/index.md rename to stackql_cloudflare/website/docs/services/ai_search/instances_items/index.md index c32ae56cae0..50fe6eacf53 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/instances_items/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/instances_items/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - instances_items - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an instances_items resourc - +
Name
TypeResource
Id
Id
## Fields @@ -238,7 +238,7 @@ last_seen_at, namespace, next_action, status -FROM cloudflare.aisearch.instances_items +FROM cloudflare.ai_search.instances_items WHERE id = '{{ id }}' -- required AND account_id = '{{ account_id }}' -- required AND name = '{{ name }}' -- required diff --git a/stackql_cloudflare/website/docs/services/ai/sync/index.md b/stackql_cloudflare/website/docs/services/ai_search/instances_search/index.md similarity index 54% rename from stackql_cloudflare/website/docs/services/ai/sync/index.md rename to stackql_cloudflare/website/docs/services/ai_search/instances_search/index.md index e00d395b0a7..d9e8b6998f2 100644 --- a/stackql_cloudflare/website/docs/services/ai/sync/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/instances_search/index.md @@ -1,10 +1,10 @@ --- -title: sync +title: instances_search hide_title: false hide_table_of_contents: false keywords: - - sync - - ai + - instances_search + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -19,21 +19,52 @@ import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a sync resource. +Creates, updates, deletes, gets or lists an instances_search resource. ## Overview - + - +
Name
Name
TypeResource
Id
Id
## Fields The following fields are returned by `SELECT` queries: -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +Returns the search results. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
boolean
+ + ## Methods @@ -51,11 +82,11 @@ The following methods are available for this resource: - - + + id, account_id - + Executes a semantic search query against an AI Search instance to find relevant indexed content. @@ -86,28 +117,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# -## `UPDATE` examples +## `SELECT` examples - + -No description available. +Executes a semantic search query against an AI Search instance to find relevant indexed content. ```sql -UPDATE cloudflare.ai.sync -SET --- No updatable properties -WHERE -id = '{{ id }}' --required -AND account_id = '{{ account_id }}' --required -RETURNING +SELECT result, -success; +success +FROM cloudflare.ai_search.instances_search +WHERE id = '{{ id }}' -- required +AND account_id = '{{ account_id }}' -- required +; ``` diff --git a/stackql_cloudflare/website/docs/services/aisearch/instances_stats/index.md b/stackql_cloudflare/website/docs/services/ai_search/instances_stats/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/instances_stats/index.md rename to stackql_cloudflare/website/docs/services/ai_search/instances_stats/index.md index 63503d43dd0..e42c4605544 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/instances_stats/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/instances_stats/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - instances_stats - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an instances_stats resourc - +
Name
TypeResource
Id
Id
## Fields @@ -181,7 +181,7 @@ outdated, queued, running, skipped -FROM cloudflare.aisearch.instances_stats +FROM cloudflare.ai_search.instances_stats WHERE id = '{{ id }}' -- required AND account_id = '{{ account_id }}' -- required ; diff --git a/stackql_cloudflare/website/docs/services/aisearch/item_chunks/index.md b/stackql_cloudflare/website/docs/services/ai_search/item_chunks/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/item_chunks/index.md rename to stackql_cloudflare/website/docs/services/ai_search/item_chunks/index.md index f83c786cc82..f26ac94da5f 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/item_chunks/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/item_chunks/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - item_chunks - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an item_chunks resource. - +
Name
TypeResource
Id
Id
## Fields @@ -171,7 +171,7 @@ end_byte, item, start_byte, text -FROM cloudflare.aisearch.item_chunks +FROM cloudflare.ai_search.item_chunks WHERE id = '{{ id }}' -- required AND item_id = '{{ item_id }}' -- required AND account_id = '{{ account_id }}' -- required diff --git a/stackql_cloudflare/website/docs/services/aisearch/item_logs/index.md b/stackql_cloudflare/website/docs/services/ai_search/item_logs/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/item_logs/index.md rename to stackql_cloudflare/website/docs/services/ai_search/item_logs/index.md index 83f7c4a9f39..6c4b80abe3f 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/item_logs/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/item_logs/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - item_logs - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an item_logs resource. - +
Name
TypeResource
Id
Id
## Fields @@ -183,7 +183,7 @@ fileKey, message, processingTimeMs, timestamp -FROM cloudflare.aisearch.item_logs +FROM cloudflare.ai_search.item_logs WHERE id = '{{ id }}' -- required AND item_id = '{{ item_id }}' -- required AND account_id = '{{ account_id }}' -- required diff --git a/stackql_cloudflare/website/docs/services/aisearch/items/index.md b/stackql_cloudflare/website/docs/services/ai_search/items/index.md similarity index 97% rename from stackql_cloudflare/website/docs/services/aisearch/items/index.md rename to stackql_cloudflare/website/docs/services/ai_search/items/index.md index e89581c7613..f06a357e32b 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/items/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/items/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - items - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an items resource. - +
Name
TypeResource
Id
Id
## Fields @@ -231,7 +231,7 @@ last_seen_at, namespace, next_action, status -FROM cloudflare.aisearch.items +FROM cloudflare.ai_search.items WHERE id = '{{ id }}' -- required AND item_id = '{{ item_id }}' -- required AND account_id = '{{ account_id }}' -- required @@ -256,7 +256,7 @@ AND name = '{{ name }}' -- required Uploads a file to a managed AI Search instance via multipart/form-data (max 4MB). ```sql -INSERT INTO cloudflare.aisearch.items ( +INSERT INTO cloudflare.ai_search.items ( file, metadata, wait_for_completion, @@ -323,7 +323,7 @@ success Syncs an item to an AI Search instance index. ```sql -UPDATE cloudflare.aisearch.items +UPDATE cloudflare.ai_search.items SET next_action = '{{ next_action }}', wait_for_completion = {{ wait_for_completion }} @@ -354,7 +354,7 @@ success; Creates or updates an indexed item in an AI Search instance. ```sql -REPLACE cloudflare.aisearch.items +REPLACE cloudflare.ai_search.items SET key = '{{ key }}', next_action = '{{ next_action }}', @@ -386,7 +386,7 @@ success; Deletes a file from a managed AI Search instance and triggers a reindex. ```sql -DELETE FROM cloudflare.aisearch.items +DELETE FROM cloudflare.ai_search.items WHERE id = '{{ id }}' --required AND item_id = '{{ item_id }}' --required AND account_id = '{{ account_id }}' --required diff --git a/stackql_cloudflare/website/docs/services/aisearch/items_download/index.md b/stackql_cloudflare/website/docs/services/ai_search/items_download/index.md similarity index 95% rename from stackql_cloudflare/website/docs/services/aisearch/items_download/index.md rename to stackql_cloudflare/website/docs/services/ai_search/items_download/index.md index 8fd7a270f25..e494cc1bd3f 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/items_download/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/items_download/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - items_download - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists an items_download resource - +
Name
TypeResource
Id
Id
## Fields @@ -137,7 +137,7 @@ Downloads the raw file content for a specific item from the managed AI Search in ```sql SELECT contents -FROM cloudflare.aisearch.items_download +FROM cloudflare.ai_search.items_download WHERE id = '{{ id }}' -- required AND item_id = '{{ item_id }}' -- required AND account_id = '{{ account_id }}' -- required diff --git a/stackql_cloudflare/website/docs/services/aisearch/jobs/index.md b/stackql_cloudflare/website/docs/services/ai_search/jobs/index.md similarity index 97% rename from stackql_cloudflare/website/docs/services/aisearch/jobs/index.md rename to stackql_cloudflare/website/docs/services/ai_search/jobs/index.md index 67eadb4a297..93d22060660 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/jobs/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/jobs/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - jobs - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a jobs resource. - +
Name
TypeResource
Id
Id
## Fields @@ -264,7 +264,7 @@ ended_at, last_seen_at, source, started_at -FROM cloudflare.aisearch.jobs +FROM cloudflare.ai_search.jobs WHERE id = '{{ id }}' -- required AND job_id = '{{ job_id }}' -- required AND account_id = '{{ account_id }}' -- required @@ -284,7 +284,7 @@ ended_at, last_seen_at, source, started_at -FROM cloudflare.aisearch.jobs +FROM cloudflare.ai_search.jobs WHERE id = '{{ id }}' -- required AND account_id = '{{ account_id }}' -- required AND page = '{{ page }}' @@ -309,7 +309,7 @@ AND per_page = '{{ per_page }}' Creates a new indexing job for an AI Search instance. ```sql -INSERT INTO cloudflare.aisearch.jobs ( +INSERT INTO cloudflare.ai_search.jobs ( description, id, account_id @@ -357,7 +357,7 @@ success Updates the status of an AI Search indexing job. ```sql -UPDATE cloudflare.aisearch.jobs +UPDATE cloudflare.ai_search.jobs SET action = '{{ action }}' WHERE @@ -376,7 +376,7 @@ success; Updates the status of an AI Search indexing job. ```sql -UPDATE cloudflare.aisearch.jobs +UPDATE cloudflare.ai_search.jobs SET action = '{{ action }}' WHERE diff --git a/stackql_cloudflare/website/docs/services/aisearch/jobs_logs/index.md b/stackql_cloudflare/website/docs/services/ai_search/jobs_logs/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/jobs_logs/index.md rename to stackql_cloudflare/website/docs/services/ai_search/jobs_logs/index.md index bd88116d51f..29f1b80c4ef 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/jobs_logs/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/jobs_logs/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - jobs_logs - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a jobs_logs resource. - +
Name
TypeResource
Id
Id
## Fields @@ -160,7 +160,7 @@ id, created_at, message, message_type -FROM cloudflare.aisearch.jobs_logs +FROM cloudflare.ai_search.jobs_logs WHERE id = '{{ id }}' -- required AND job_id = '{{ job_id }}' -- required AND account_id = '{{ account_id }}' -- required diff --git a/stackql_cloudflare/website/docs/services/ai_search/namespace_instance_chat_completions/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespace_instance_chat_completions/index.md new file mode 100644 index 00000000000..50c2be7fde3 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai_search/namespace_instance_chat_completions/index.md @@ -0,0 +1,166 @@ +--- +title: namespace_instance_chat_completions +hide_title: false +hide_table_of_contents: false +keywords: + - namespace_instance_chat_completions + - ai_search + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a namespace_instance_chat_completions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Returns the chat completions results with retrieved files. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
array
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_id, namePerforms a chat completion request against an AI Search instance, using indexed content as context for generating responses.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
stringResource name.
+ +## `SELECT` examples + + + + +Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. + +```sql +SELECT +id, +choices, +chunks, +model, +object +FROM cloudflare.ai_search.namespace_instance_chat_completions +WHERE id = '{{ id }}' -- required +AND account_id = '{{ account_id }}' -- required +AND name = '{{ name }}' -- required +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespace_instances/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespace_instances/index.md similarity index 98% rename from stackql_cloudflare/website/docs/services/aisearch/namespace_instances/index.md rename to stackql_cloudflare/website/docs/services/ai_search/namespace_instances/index.md index a67cd8fe0e7..5f855fa269a 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/namespace_instances/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/namespace_instances/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - namespace_instances - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a namespace_instances reso - +
Name
TypeResource
Id
Id
## Fields @@ -620,7 +620,7 @@ source_params, status, sync_interval, type -FROM cloudflare.aisearch.namespace_instances +FROM cloudflare.ai_search.namespace_instances WHERE account_id = '{{ account_id }}' -- required AND id = '{{ id }}' -- required AND name = '{{ name }}' -- required @@ -671,7 +671,7 @@ source_params, status, sync_interval, type -FROM cloudflare.aisearch.namespace_instances +FROM cloudflare.ai_search.namespace_instances WHERE account_id = '{{ account_id }}' -- required AND name = '{{ name }}' -- required AND page = '{{ page }}' @@ -700,7 +700,7 @@ AND order_by_direction = '{{ order_by_direction }}' Create a new instance. ```sql -INSERT INTO cloudflare.aisearch.namespace_instances ( +INSERT INTO cloudflare.ai_search.namespace_instances ( ai_gateway_id, ai_search_model, cache, @@ -939,7 +939,7 @@ success Update instance. ```sql -REPLACE cloudflare.aisearch.namespace_instances +REPLACE cloudflare.ai_search.namespace_instances SET ai_gateway_id = '{{ ai_gateway_id }}', ai_search_model = '{{ ai_search_model }}', @@ -996,7 +996,7 @@ success; Delete instance. ```sql -DELETE FROM cloudflare.aisearch.namespace_instances +DELETE FROM cloudflare.ai_search.namespace_instances WHERE account_id = '{{ account_id }}' --required AND id = '{{ id }}' --required AND name = '{{ name }}' --required diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespaces/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespaces/index.md similarity index 95% rename from stackql_cloudflare/website/docs/services/aisearch/namespaces/index.md rename to stackql_cloudflare/website/docs/services/ai_search/namespaces/index.md index d8cfa39d7ed..1d4d715bf82 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/namespaces/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/namespaces/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - namespaces - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a namespaces resource. - +
Name
TypeResource
Id
Id
## Fields @@ -215,7 +215,7 @@ SELECT name, created_at, description -FROM cloudflare.aisearch.namespaces +FROM cloudflare.ai_search.namespaces WHERE account_id = '{{ account_id }}' -- required AND name = '{{ name }}' -- required ; @@ -230,7 +230,7 @@ SELECT name, created_at, description -FROM cloudflare.aisearch.namespaces +FROM cloudflare.ai_search.namespaces WHERE account_id = '{{ account_id }}' -- required AND page = '{{ page }}' AND per_page = '{{ per_page }}' @@ -255,7 +255,7 @@ AND search = '{{ search }}' Create a new namespace. ```sql -INSERT INTO cloudflare.aisearch.namespaces ( +INSERT INTO cloudflare.ai_search.namespaces ( description, name, account_id @@ -303,7 +303,7 @@ success Update namespace. ```sql -REPLACE cloudflare.aisearch.namespaces +REPLACE cloudflare.ai_search.namespaces SET description = '{{ description }}' WHERE @@ -330,7 +330,7 @@ success; Delete namespace. ```sql -DELETE FROM cloudflare.aisearch.namespaces +DELETE FROM cloudflare.ai_search.namespaces WHERE account_id = '{{ account_id }}' --required AND name = '{{ name }}' --required ; diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_job_logs/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_job_logs/index.md similarity index 95% rename from stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_job_logs/index.md rename to stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_job_logs/index.md index d75879569fa..4664e163c6d 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_job_logs/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_job_logs/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - namespaces_instance_job_logs - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a namespaces_instance_job_logs Name TypeResource -Id +Id ## Fields @@ -165,7 +165,7 @@ id, created_at, message, message_type -FROM cloudflare.aisearch.namespaces_instance_job_logs +FROM cloudflare.ai_search.namespaces_instance_job_logs WHERE id = '{{ id }}' -- required AND job_id = '{{ job_id }}' -- required AND account_id = '{{ account_id }}' -- required diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_jobs/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_jobs/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_jobs/index.md rename to stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_jobs/index.md index b12feb9f619..233be138191 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_jobs/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_jobs/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - namespaces_instance_jobs - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a namespaces_instance_jobs - +
Name
TypeResource
Id
Id
## Fields @@ -250,7 +250,7 @@ ended_at, last_seen_at, source, started_at -FROM cloudflare.aisearch.namespaces_instance_jobs +FROM cloudflare.ai_search.namespaces_instance_jobs WHERE id = '{{ id }}' -- required AND job_id = '{{ job_id }}' -- required AND account_id = '{{ account_id }}' -- required @@ -271,7 +271,7 @@ ended_at, last_seen_at, source, started_at -FROM cloudflare.aisearch.namespaces_instance_jobs +FROM cloudflare.ai_search.namespaces_instance_jobs WHERE id = '{{ id }}' -- required AND account_id = '{{ account_id }}' -- required AND name = '{{ name }}' -- required @@ -297,7 +297,7 @@ AND per_page = '{{ per_page }}' Creates a new indexing job for an AI Search instance. ```sql -INSERT INTO cloudflare.aisearch.namespaces_instance_jobs ( +INSERT INTO cloudflare.ai_search.namespaces_instance_jobs ( description, id, account_id, diff --git a/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_search/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_search/index.md new file mode 100644 index 00000000000..26884316818 --- /dev/null +++ b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_search/index.md @@ -0,0 +1,148 @@ +--- +title: namespaces_instance_search +hide_title: false +hide_table_of_contents: false +keywords: + - namespaces_instance_search + - ai_search + - cloudflare + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage cloudflare resources using SQL +custom_edit_url: null +image: /img/stackql-cloudflare-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a namespaces_instance_search resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Returns the search results. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
boolean
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_id, nameExecutes a semantic search query against an AI Search instance to find relevant indexed content.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
stringResource name.
+ +## `SELECT` examples + + + + +Executes a semantic search query against an AI Search instance to find relevant indexed content. + +```sql +SELECT +result, +success +FROM cloudflare.ai_search.namespaces_instance_search +WHERE id = '{{ id }}' -- required +AND account_id = '{{ account_id }}' -- required +AND name = '{{ name }}' -- required +; +``` + + diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_stats/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_stats/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_stats/index.md rename to stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_stats/index.md index 1c6a5d7873f..3622499b76d 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_stats/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/namespaces_instance_stats/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - namespaces_instance_stats - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a namespaces_instance_stats Name TypeResource -Id +Id ## Fields @@ -186,7 +186,7 @@ outdated, queued, running, skipped -FROM cloudflare.aisearch.namespaces_instance_stats +FROM cloudflare.ai_search.namespaces_instance_stats WHERE id = '{{ id }}' -- required AND account_id = '{{ account_id }}' -- required AND name = '{{ name }}' -- required diff --git a/stackql_cloudflare/website/docs/services/workers/builds_builds/index.md b/stackql_cloudflare/website/docs/services/ai_search/namespaces_search/index.md similarity index 63% rename from stackql_cloudflare/website/docs/services/workers/builds_builds/index.md rename to stackql_cloudflare/website/docs/services/ai_search/namespaces_search/index.md index edb0772f276..cacd8327064 100644 --- a/stackql_cloudflare/website/docs/services/workers/builds_builds/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/namespaces_search/index.md @@ -1,10 +1,10 @@ --- -title: builds_builds +title: namespaces_search hide_title: false hide_table_of_contents: false keywords: - - builds_builds - - workers + - namespaces_search + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -19,13 +19,13 @@ import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a builds_builds resource. +Creates, updates, deletes, gets or lists a namespaces_search resource. ## Overview - + - +
Name
Name
TypeResource
Id
Id
## Fields @@ -33,14 +33,14 @@ Creates, updates, deletes, gets or lists a builds_builds resource. The following fields are returned by `SELECT` queries: - + -Builds retrieved successfully +Returns the merged search results from all instances. @@ -52,10 +52,15 @@ Builds retrieved successfully - + + + + + +
object
boolean
@@ -77,11 +82,11 @@ The following methods are available for this resource: - + - account_id - version_ids - Retrieve builds for specific version IDs + account_id, name + + @@ -104,10 +109,10 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The Cloudflare account ID. - - + + string - + Resource name. @@ -115,21 +120,22 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# ## `SELECT` examples - + -Retrieve builds for specific version IDs +Returns the merged search results from all instances. ```sql SELECT -builds -FROM cloudflare.workers.builds_builds +result, +success +FROM cloudflare.ai_search.namespaces_search WHERE account_id = '{{ account_id }}' -- required -AND version_ids = '{{ version_ids }}' +AND name = '{{ name }}' -- required ; ``` diff --git a/stackql_cloudflare/website/docs/services/aisearch/tokens/index.md b/stackql_cloudflare/website/docs/services/ai_search/tokens/index.md similarity index 96% rename from stackql_cloudflare/website/docs/services/aisearch/tokens/index.md rename to stackql_cloudflare/website/docs/services/ai_search/tokens/index.md index bd8eb57cc6d..197bb0de1c4 100644 --- a/stackql_cloudflare/website/docs/services/aisearch/tokens/index.md +++ b/stackql_cloudflare/website/docs/services/ai_search/tokens/index.md @@ -4,7 +4,7 @@ hide_title: false hide_table_of_contents: false keywords: - tokens - - aisearch + - ai_search - cloudflare - infrastructure-as-code - configuration-as-data @@ -25,7 +25,7 @@ Creates, updates, deletes, gets or lists a tokens resource. - +
Name
TypeResource
Id
Id
## Fields @@ -281,7 +281,7 @@ enabled, legacy, modified_at, modified_by -FROM cloudflare.aisearch.tokens +FROM cloudflare.ai_search.tokens WHERE account_id = '{{ account_id }}' -- required AND id = '{{ id }}' -- required ; @@ -302,7 +302,7 @@ enabled, legacy, modified_at, modified_by -FROM cloudflare.aisearch.tokens +FROM cloudflare.ai_search.tokens WHERE account_id = '{{ account_id }}' -- required AND page = '{{ page }}' AND per_page = '{{ per_page }}' @@ -327,7 +327,7 @@ AND search = '{{ search }}' Create a new token. ```sql -INSERT INTO cloudflare.aisearch.tokens ( +INSERT INTO cloudflare.ai_search.tokens ( cf_api_id, cf_api_key, legacy, @@ -382,7 +382,7 @@ success Update token. ```sql -REPLACE cloudflare.aisearch.tokens +REPLACE cloudflare.ai_search.tokens SET cf_api_id = '{{ cf_api_id }}', cf_api_key = '{{ cf_api_key }}', @@ -415,7 +415,7 @@ success; Delete token. ```sql -DELETE FROM cloudflare.aisearch.tokens +DELETE FROM cloudflare.ai_search.tokens WHERE account_id = '{{ account_id }}' --required AND id = '{{ id }}' --required ; diff --git a/stackql_cloudflare/website/docs/services/aisearch/chat_completions/index.md b/stackql_cloudflare/website/docs/services/aisearch/chat_completions/index.md deleted file mode 100644 index c0a5e9a934a..00000000000 --- a/stackql_cloudflare/website/docs/services/aisearch/chat_completions/index.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -title: chat_completions -hide_title: false -hide_table_of_contents: false -keywords: - - chat_completions - - aisearch - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a chat_completions resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_id, messagesPerforms a chat completion request against an AI Search instance, using indexed content as context for generating responses.
account_id, name, messages, ai_search_optionsPerforms a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
stringResource name.
- -## `INSERT` examples - - - - -Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. - -```sql -INSERT INTO cloudflare.aisearch.chat_completions ( -ai_search_options, -messages, -model, -stream, -id, -account_id -) -SELECT -'{{ ai_search_options }}', -'{{ messages }}' /* required */, -'{{ model }}', -{{ stream }}, -'{{ id }}', -'{{ account_id }}' -RETURNING -id, -choices, -chunks, -model, -object -; -``` - - - -Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response. - -```sql -INSERT INTO cloudflare.aisearch.chat_completions ( -ai_search_options, -messages, -model, -stream, -account_id, -name -) -SELECT -'{{ ai_search_options }}' /* required */, -'{{ messages }}' /* required */, -'{{ model }}', -{{ stream }}, -'{{ account_id }}', -'{{ name }}' -RETURNING -id, -choices, -chunks, -errors, -model, -object -; -``` - - - -{`# Description fields are for documentation purposes -- name: chat_completions - props: - - name: id - value: "{{ id }}" - description: Required parameter for the chat_completions resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the chat_completions resource. - - name: name - value: "{{ name }}" - description: Required parameter for the chat_completions resource. - - name: ai_search_options - value: - cache: - cache_threshold: "{{ cache_threshold }}" - enabled: {{ enabled }} - instance_ids: - - "{{ instance_ids }}" - query_rewrite: - enabled: {{ enabled }} - model: "{{ model }}" - rewrite_prompt: "{{ rewrite_prompt }}" - reranking: - enabled: {{ enabled }} - match_threshold: {{ match_threshold }} - model: "{{ model }}" - retrieval: - boost_by: - - direction: "{{ direction }}" - field: "{{ field }}" - context_expansion: {{ context_expansion }} - filters: "{{ filters }}" - fusion_method: "{{ fusion_method }}" - keyword_match_mode: "{{ keyword_match_mode }}" - match_threshold: {{ match_threshold }} - max_num_results: {{ max_num_results }} - retrieval_type: "{{ retrieval_type }}" - return_on_failure: {{ return_on_failure }} - - name: messages - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: model - value: "{{ model }}" - valid_values: ['@cf/meta/llama-3.3-70b-instruct-fp8-fast', '@cf/zai-org/glm-4.7-flash', '@cf/meta/llama-3.1-8b-instruct-fast', '@cf/meta/llama-3.1-8b-instruct-fp8', '@cf/meta/llama-4-scout-17b-16e-instruct', '@cf/qwen/qwen3-30b-a3b-fp8', '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b', '@cf/moonshotai/kimi-k2-instruct', '@cf/google/gemma-3-12b-it', '@cf/google/gemma-4-26b-a4b-it', '@cf/moonshotai/kimi-k2.5', 'anthropic/claude-3-7-sonnet', 'anthropic/claude-sonnet-4', 'anthropic/claude-opus-4', 'anthropic/claude-3-5-haiku', 'cerebras/qwen-3-235b-a22b-instruct', 'cerebras/qwen-3-235b-a22b-thinking', 'cerebras/llama-3.3-70b', 'cerebras/llama-4-maverick-17b-128e-instruct', 'cerebras/llama-4-scout-17b-16e-instruct', 'cerebras/gpt-oss-120b', 'google-ai-studio/gemini-2.5-flash', 'google-ai-studio/gemini-2.5-pro', 'grok/grok-4', 'groq/llama-3.3-70b-versatile', 'groq/llama-3.1-8b-instant', 'openai/gpt-5', 'openai/gpt-5-mini', 'openai/gpt-5-nano'] - - name: stream - value: {{ stream }} -`} - - - diff --git a/stackql_cloudflare/website/docs/services/aisearch/index.md b/stackql_cloudflare/website/docs/services/aisearch/index.md deleted file mode 100644 index 2a70de59ff1..00000000000 --- a/stackql_cloudflare/website/docs/services/aisearch/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: aisearch -hide_title: false -hide_table_of_contents: false -keywords: - - aisearch - - cloudflare - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -aisearch service documentation. - -:::info[Service Summary] - -total resources: __20__ - -::: - -## Resources -
-
-chat_completions
-instances
-instances_items
-instances_search
-instances_stats
-item_chunks
-item_logs
-items
-items_download
-jobs -
-
-jobs_logs
-namespace_instance_chat_completions
-namespace_instances
-namespaces
-namespaces_instance_job_logs
-namespaces_instance_jobs
-namespaces_instance_search
-namespaces_instance_stats
-namespaces_search
-tokens -
-
\ No newline at end of file diff --git a/stackql_cloudflare/website/docs/services/aisearch/instances_search/index.md b/stackql_cloudflare/website/docs/services/aisearch/instances_search/index.md deleted file mode 100644 index d0415323949..00000000000 --- a/stackql_cloudflare/website/docs/services/aisearch/instances_search/index.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: instances_search -hide_title: false -hide_table_of_contents: false -keywords: - - instances_search - - aisearch - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists an instances_search resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_idExecutes a semantic search query against an AI Search instance to find relevant indexed content.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
- -## `INSERT` examples - - - - -Executes a semantic search query against an AI Search instance to find relevant indexed content. - -```sql -INSERT INTO cloudflare.aisearch.instances_search ( -ai_search_options, -messages, -query, -id, -account_id -) -SELECT -'{{ ai_search_options }}', -'{{ messages }}', -'{{ query }}', -'{{ id }}', -'{{ account_id }}' -RETURNING -result, -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: instances_search - props: - - name: id - value: "{{ id }}" - description: Required parameter for the instances_search resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the instances_search resource. - - name: ai_search_options - value: - cache: - cache_threshold: "{{ cache_threshold }}" - enabled: {{ enabled }} - query_rewrite: - enabled: {{ enabled }} - model: "{{ model }}" - rewrite_prompt: "{{ rewrite_prompt }}" - reranking: - enabled: {{ enabled }} - match_threshold: {{ match_threshold }} - model: "{{ model }}" - retrieval: - boost_by: - - direction: "{{ direction }}" - field: "{{ field }}" - context_expansion: {{ context_expansion }} - filters: "{{ filters }}" - fusion_method: "{{ fusion_method }}" - keyword_match_mode: "{{ keyword_match_mode }}" - match_threshold: {{ match_threshold }} - max_num_results: {{ max_num_results }} - retrieval_type: "{{ retrieval_type }}" - return_on_failure: {{ return_on_failure }} - - name: messages - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: query - value: "{{ query }}" - description: | - A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both. -`} - - - diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespace_instance_chat_completions/index.md b/stackql_cloudflare/website/docs/services/aisearch/namespace_instance_chat_completions/index.md deleted file mode 100644 index f7a47abbeba..00000000000 --- a/stackql_cloudflare/website/docs/services/aisearch/namespace_instance_chat_completions/index.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -title: namespace_instance_chat_completions -hide_title: false -hide_table_of_contents: false -keywords: - - namespace_instance_chat_completions - - aisearch - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a namespace_instance_chat_completions resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_id, name, messagesPerforms a chat completion request against an AI Search instance, using indexed content as context for generating responses.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
stringResource name.
- -## `INSERT` examples - - - - -Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. - -```sql -INSERT INTO cloudflare.aisearch.namespace_instance_chat_completions ( -ai_search_options, -messages, -model, -stream, -id, -account_id, -name -) -SELECT -'{{ ai_search_options }}', -'{{ messages }}' /* required */, -'{{ model }}', -{{ stream }}, -'{{ id }}', -'{{ account_id }}', -'{{ name }}' -RETURNING -id, -choices, -chunks, -model, -object -; -``` - - - -{`# Description fields are for documentation purposes -- name: namespace_instance_chat_completions - props: - - name: id - value: "{{ id }}" - description: Required parameter for the namespace_instance_chat_completions resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the namespace_instance_chat_completions resource. - - name: name - value: "{{ name }}" - description: Required parameter for the namespace_instance_chat_completions resource. - - name: ai_search_options - value: - cache: - cache_threshold: "{{ cache_threshold }}" - enabled: {{ enabled }} - query_rewrite: - enabled: {{ enabled }} - model: "{{ model }}" - rewrite_prompt: "{{ rewrite_prompt }}" - reranking: - enabled: {{ enabled }} - match_threshold: {{ match_threshold }} - model: "{{ model }}" - retrieval: - boost_by: - - direction: "{{ direction }}" - field: "{{ field }}" - context_expansion: {{ context_expansion }} - filters: "{{ filters }}" - fusion_method: "{{ fusion_method }}" - keyword_match_mode: "{{ keyword_match_mode }}" - match_threshold: {{ match_threshold }} - max_num_results: {{ max_num_results }} - retrieval_type: "{{ retrieval_type }}" - return_on_failure: {{ return_on_failure }} - - name: messages - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: model - value: "{{ model }}" - valid_values: ['@cf/meta/llama-3.3-70b-instruct-fp8-fast', '@cf/zai-org/glm-4.7-flash', '@cf/meta/llama-3.1-8b-instruct-fast', '@cf/meta/llama-3.1-8b-instruct-fp8', '@cf/meta/llama-4-scout-17b-16e-instruct', '@cf/qwen/qwen3-30b-a3b-fp8', '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b', '@cf/moonshotai/kimi-k2-instruct', '@cf/google/gemma-3-12b-it', '@cf/google/gemma-4-26b-a4b-it', '@cf/moonshotai/kimi-k2.5', 'anthropic/claude-3-7-sonnet', 'anthropic/claude-sonnet-4', 'anthropic/claude-opus-4', 'anthropic/claude-3-5-haiku', 'cerebras/qwen-3-235b-a22b-instruct', 'cerebras/qwen-3-235b-a22b-thinking', 'cerebras/llama-3.3-70b', 'cerebras/llama-4-maverick-17b-128e-instruct', 'cerebras/llama-4-scout-17b-16e-instruct', 'cerebras/gpt-oss-120b', 'google-ai-studio/gemini-2.5-flash', 'google-ai-studio/gemini-2.5-pro', 'grok/grok-4', 'groq/llama-3.3-70b-versatile', 'groq/llama-3.1-8b-instant', 'openai/gpt-5', 'openai/gpt-5-mini', 'openai/gpt-5-nano'] - - name: stream - value: {{ stream }} -`} - - - diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_search/index.md b/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_search/index.md deleted file mode 100644 index 38058a0df5c..00000000000 --- a/stackql_cloudflare/website/docs/services/aisearch/namespaces_instance_search/index.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -title: namespaces_instance_search -hide_title: false -hide_table_of_contents: false -keywords: - - namespaces_instance_search - - aisearch - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a namespaces_instance_search resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
id, account_id, nameExecutes a semantic search query against an AI Search instance to find relevant indexed content.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource ID.
stringResource name.
- -## `INSERT` examples - - - - -Executes a semantic search query against an AI Search instance to find relevant indexed content. - -```sql -INSERT INTO cloudflare.aisearch.namespaces_instance_search ( -ai_search_options, -messages, -query, -id, -account_id, -name -) -SELECT -'{{ ai_search_options }}', -'{{ messages }}', -'{{ query }}', -'{{ id }}', -'{{ account_id }}', -'{{ name }}' -RETURNING -result, -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: namespaces_instance_search - props: - - name: id - value: "{{ id }}" - description: Required parameter for the namespaces_instance_search resource. - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the namespaces_instance_search resource. - - name: name - value: "{{ name }}" - description: Required parameter for the namespaces_instance_search resource. - - name: ai_search_options - value: - cache: - cache_threshold: "{{ cache_threshold }}" - enabled: {{ enabled }} - query_rewrite: - enabled: {{ enabled }} - model: "{{ model }}" - rewrite_prompt: "{{ rewrite_prompt }}" - reranking: - enabled: {{ enabled }} - match_threshold: {{ match_threshold }} - model: "{{ model }}" - retrieval: - boost_by: - - direction: "{{ direction }}" - field: "{{ field }}" - context_expansion: {{ context_expansion }} - filters: "{{ filters }}" - fusion_method: "{{ fusion_method }}" - keyword_match_mode: "{{ keyword_match_mode }}" - match_threshold: {{ match_threshold }} - max_num_results: {{ max_num_results }} - retrieval_type: "{{ retrieval_type }}" - return_on_failure: {{ return_on_failure }} - - name: messages - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: query - value: "{{ query }}" - description: | - A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both. -`} - - - diff --git a/stackql_cloudflare/website/docs/services/aisearch/namespaces_search/index.md b/stackql_cloudflare/website/docs/services/aisearch/namespaces_search/index.md deleted file mode 100644 index 6288631a5f4..00000000000 --- a/stackql_cloudflare/website/docs/services/aisearch/namespaces_search/index.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: namespaces_search -hide_title: false -hide_table_of_contents: false -keywords: - - namespaces_search - - aisearch - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a namespaces_search resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_id, name, ai_search_options
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
stringResource name.
- -## `INSERT` examples - - - - -No description available. - -```sql -INSERT INTO cloudflare.aisearch.namespaces_search ( -ai_search_options, -messages, -query, -account_id, -name -) -SELECT -'{{ ai_search_options }}' /* required */, -'{{ messages }}', -'{{ query }}', -'{{ account_id }}', -'{{ name }}' -RETURNING -result, -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: namespaces_search - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the namespaces_search resource. - - name: name - value: "{{ name }}" - description: Required parameter for the namespaces_search resource. - - name: ai_search_options - value: - cache: - cache_threshold: "{{ cache_threshold }}" - enabled: {{ enabled }} - instance_ids: - - "{{ instance_ids }}" - query_rewrite: - enabled: {{ enabled }} - model: "{{ model }}" - rewrite_prompt: "{{ rewrite_prompt }}" - reranking: - enabled: {{ enabled }} - match_threshold: {{ match_threshold }} - model: "{{ model }}" - retrieval: - boost_by: - - direction: "{{ direction }}" - field: "{{ field }}" - context_expansion: {{ context_expansion }} - filters: "{{ filters }}" - fusion_method: "{{ fusion_method }}" - keyword_match_mode: "{{ keyword_match_mode }}" - match_threshold: {{ match_threshold }} - max_num_results: {{ max_num_results }} - retrieval_type: "{{ retrieval_type }}" - return_on_failure: {{ return_on_failure }} - - name: messages - value: - - content: "{{ content }}" - role: "{{ role }}" - - name: query - value: "{{ query }}" - description: | - A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both. -`} - - - diff --git a/stackql_cloudflare/website/docs/services/alerting/available_alerts/index.md b/stackql_cloudflare/website/docs/services/alerting/available_alerts/index.md index f6caf04cc54..ca04b2fff34 100644 --- a/stackql_cloudflare/website/docs/services/alerting/available_alerts/index.md +++ b/stackql_cloudflare/website/docs/services/alerting/available_alerts/index.md @@ -51,6 +51,11 @@ Get Alert Types response + + + string + + @@ -116,7 +121,7 @@ Gets a list of all alert types for which an account is eligible. ```sql SELECT -* +contents FROM cloudflare.alerting.available_alerts WHERE account_id = '{{ account_id }}' -- required ; diff --git a/stackql_cloudflare/website/docs/services/billing/accounts/index.md b/stackql_cloudflare/website/docs/services/billing/accounts/index.md index 1446c2742d4..2020b3a4fda 100644 --- a/stackql_cloudflare/website/docs/services/billing/accounts/index.md +++ b/stackql_cloudflare/website/docs/services/billing/accounts/index.md @@ -32,8 +32,52 @@ Creates, updates, deletes, gets or lists an accounts resource. The following fields are returned by `SELECT` queries: -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
object
object
boolean
+ + ## Methods @@ -51,18 +95,18 @@ The following methods are available for this resource: - - + + account_id - Allows an account admin to set the can_be_enabled setting on a list of zones. + Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not. - + account_id - Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not. + Allows an account admin to set the can_be_enabled setting on a list of zones. @@ -88,35 +132,47 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# -## Lifecycle Methods +## `SELECT` examples - + -Allows an account admin to set the can_be_enabled setting on a list of zones. +Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not. ```sql -EXEC cloudflare.billing.accounts.set_pay_per_crawl_zones -@account_id='{{ account_id }}' --required -@@json= -'{ -"zones": "{{ zones }}" -}' +SELECT +errors, +messages, +result, +result_info, +success +FROM cloudflare.billing.accounts +WHERE account_id = '{{ account_id }}' -- required ; ``` - + -Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not. + +## Lifecycle Methods + + + + +Allows an account admin to set the can_be_enabled setting on a list of zones. ```sql -EXEC cloudflare.billing.accounts.query_pay_per_crawl_zones +EXEC cloudflare.billing.accounts.set_pay_per_crawl_zones @account_id='{{ account_id }}' --required @@json= '{ diff --git a/stackql_cloudflare/website/docs/services/browser_rendering/browser_rendering/index.md b/stackql_cloudflare/website/docs/services/browser_rendering/browser_rendering/index.md deleted file mode 100644 index 5da9e40449c..00000000000 --- a/stackql_cloudflare/website/docs/services/browser_rendering/browser_rendering/index.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -title: browser_rendering -hide_title: false -hide_table_of_contents: false -keywords: - - browser_rendering - - browser_rendering - - cloudflare - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage cloudflare resources using SQL -custom_edit_url: null -image: /img/stackql-cloudflare-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a browser_rendering resource. - -## Overview - - - - -
Name
TypeResource
Id
- -## Fields - -The following fields are returned by `SELECT` queries: - -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods - -The following methods are available for this resource: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAccessible byRequired ParamsOptional ParamsDescription
account_idcacheTTLFetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
account_idcacheTTLGet links from a web page.
account_idcacheTTLGets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options.
account_idcacheTTLFetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
account_id, elementscacheTTLGet meta attributes like height, width, text and others of selected elements.
account_idcacheTTLTakes a screenshot of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
account_idcacheTTLReturns the page's HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
- -## Parameters - -Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
stringThe Cloudflare account ID.
numberCache TTL default is 5s. Set to 0 to disable.
- -## Lifecycle Methods - - - - -Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.create_content -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"emulateMediaType": "{{ emulateMediaType }}", -"gotoOptions": "{{ gotoOptions }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"url": "{{ url }}", -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"html": "{{ html }}" -}' -; -``` - - - -Get links from a web page. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.create_links -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"emulateMediaType": "{{ emulateMediaType }}", -"excludeExternalLinks": {{ excludeExternalLinks }}, -"gotoOptions": "{{ gotoOptions }}", -"html": "{{ html }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"visibleLinksOnly": {{ visibleLinksOnly }}, -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"url": "{{ url }}" -}' -; -``` - - - -Gets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.create_markdown -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"emulateMediaType": "{{ emulateMediaType }}", -"gotoOptions": "{{ gotoOptions }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"url": "{{ url }}", -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"html": "{{ html }}" -}' -; -``` - - - -Fetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.create_pdf -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"emulateMediaType": "{{ emulateMediaType }}", -"gotoOptions": "{{ gotoOptions }}", -"html": "{{ html }}", -"pdfOptions": "{{ pdfOptions }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"url": "{{ url }}" -}' -; -``` - - - -Get meta attributes like height, width, text and others of selected elements. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.create_scrape -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"elements": "{{ elements }}", -"emulateMediaType": "{{ emulateMediaType }}", -"gotoOptions": "{{ gotoOptions }}", -"html": "{{ html }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"url": "{{ url }}" -}' -; -``` - - - -Takes a screenshot of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.create_screenshot -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"emulateMediaType": "{{ emulateMediaType }}", -"gotoOptions": "{{ gotoOptions }}", -"html": "{{ html }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"screenshotOptions": "{{ screenshotOptions }}", -"scrollPage": {{ scrollPage }}, -"selector": "{{ selector }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"url": "{{ url }}" -}' -; -``` - - - -Returns the page's HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others. - -```sql -EXEC cloudflare.browser_rendering.browser_rendering.snapshot -@account_id='{{ account_id }}' --required, -@cacheTTL='{{ cacheTTL }}' -@@json= -'{ -"actionTimeout": {{ actionTimeout }}, -"addScriptTag": "{{ addScriptTag }}", -"addStyleTag": "{{ addStyleTag }}", -"allowRequestPattern": "{{ allowRequestPattern }}", -"allowResourceTypes": "{{ allowResourceTypes }}", -"authenticate": "{{ authenticate }}", -"bestAttempt": {{ bestAttempt }}, -"cookies": "{{ cookies }}", -"emulateMediaType": "{{ emulateMediaType }}", -"gotoOptions": "{{ gotoOptions }}", -"html": "{{ html }}", -"rejectRequestPattern": "{{ rejectRequestPattern }}", -"rejectResourceTypes": "{{ rejectResourceTypes }}", -"screenshotOptions": "{{ screenshotOptions }}", -"setExtraHTTPHeaders": "{{ setExtraHTTPHeaders }}", -"setJavaScriptEnabled": {{ setJavaScriptEnabled }}, -"userAgent": "{{ userAgent }}", -"viewport": "{{ viewport }}", -"waitForSelector": "{{ waitForSelector }}", -"waitForTimeout": {{ waitForTimeout }}, -"url": "{{ url }}" -}' -; -``` - - diff --git a/stackql_cloudflare/website/docs/services/zero_trust/includes_73882e/index.md b/stackql_cloudflare/website/docs/services/browser_rendering/content/index.md similarity index 52% rename from stackql_cloudflare/website/docs/services/zero_trust/includes_73882e/index.md rename to stackql_cloudflare/website/docs/services/browser_rendering/content/index.md index 21b3628c167..209585ef836 100644 --- a/stackql_cloudflare/website/docs/services/zero_trust/includes_73882e/index.md +++ b/stackql_cloudflare/website/docs/services/browser_rendering/content/index.md @@ -1,10 +1,10 @@ --- -title: includes_73882e +title: content hide_title: false hide_table_of_contents: false keywords: - - includes_73882e - - zero_trust + - content + - browser_rendering - cloudflare - infrastructure-as-code - configuration-as-data @@ -19,13 +19,13 @@ import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists an includes_73882e resource. +Creates, updates, deletes, gets or lists a content resource. ## Overview - + - +
Name
Name
TypeResource
Id
Id
## Fields @@ -33,14 +33,14 @@ Creates, updates, deletes, gets or lists an includes_73882e resourc The following fields are returned by `SELECT` queries: - + -Get the Split Tunnel include list response. +Returns the page's content. @@ -52,19 +52,9 @@ Get the Split Tunnel include list response. - + - - - - - - - - - - - +
stringThe address in CIDR format to include in the tunnel. If `address` is present, `host` must not be present. (example: 192.0.2.0/24, x-stainless-terraform-configurability: computed_optional)
stringA description of the Split Tunnel item, displayed in the client UI. (example: Include testing domains in the tunnel, x-stainless-terraform-configurability: computed_optional)
stringThe domain name to include in the tunnel. If `host` is present, `address` must not be present. (example: *.example.com, x-stainless-terraform-configurability: computed_optional)
@@ -87,11 +77,11 @@ The following methods are available for this resource: - + account_id - - Fetches the list of routes included in the WARP client's tunnel. + cacheTTL + Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour. @@ -114,28 +104,32 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The Cloudflare account ID. + + + number + Cache TTL default is 5s. Set to 0 to disable. + ## `SELECT` examples - + -Fetches the list of routes included in the WARP client's tunnel. +Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour. ```sql SELECT -address, -description, -host -FROM cloudflare.zero_trust.includes_73882e +contents +FROM cloudflare.browser_rendering.content WHERE account_id = '{{ account_id }}' -- required +AND cacheTTL = '{{ cacheTTL }}' ; ``` diff --git a/stackql_cloudflare/website/docs/services/browser_rendering/index.md b/stackql_cloudflare/website/docs/services/browser_rendering/index.md index 52c4f6c0e20..03bd7b49e57 100644 --- a/stackql_cloudflare/website/docs/services/browser_rendering/index.md +++ b/stackql_cloudflare/website/docs/services/browser_rendering/index.md @@ -18,7 +18,7 @@ browser_rendering service documentation. :::info[Service Summary] -total resources: __11__ +total resources: __18__ ::: @@ -26,17 +26,24 @@ total resources: __11__
browser
-browser_rendering
+content
crawl
json
json_activate
-json_close +json_close
+json_extract
+json_list
+json_protocol
-json_list
-json_protocol
json_version
+links
+markdown
+pdf
+scrape
+screenshot
session
+snapshot
targets
\ No newline at end of file diff --git a/stackql_cloudflare/website/docs/services/browser_rendering/json/index.md b/stackql_cloudflare/website/docs/services/browser_rendering/json/index.md index 21ab3e302e6..5565be91941 100644 --- a/stackql_cloudflare/website/docs/services/browser_rendering/json/index.md +++ b/stackql_cloudflare/website/docs/services/browser_rendering/json/index.md @@ -113,13 +113,6 @@ The following methods are available for this resource: Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts. - - - - account_id - cacheTTL - Gets json from a webpage from a provided URL or HTML. Pass `prompt` or `schema` in the body. Control page loading with `gotoOptions` and `waitFor*` options. - @@ -146,11 +139,6 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The session ID. - - - number - Cache TTL default is 5s. Set to 0 to disable. - @@ -182,222 +170,3 @@ AND session_id = '{{ session_id }}' -- required ``` - - -## `INSERT` examples - - - - -Gets json from a webpage from a provided URL or HTML. Pass `prompt` or `schema` in the body. Control page loading with `gotoOptions` and `waitFor*` options. - -```sql -INSERT INTO cloudflare.browser_rendering.json ( -actionTimeout, -addScriptTag, -addStyleTag, -allowRequestPattern, -allowResourceTypes, -authenticate, -bestAttempt, -cookies, -custom_ai, -emulateMediaType, -gotoOptions, -html, -prompt, -rejectRequestPattern, -rejectResourceTypes, -response_format, -setExtraHTTPHeaders, -setJavaScriptEnabled, -userAgent, -viewport, -waitForSelector, -waitForTimeout, -url, -account_id, -cacheTTL -) -SELECT -{{ actionTimeout }}, -'{{ addScriptTag }}', -'{{ addStyleTag }}', -'{{ allowRequestPattern }}', -'{{ allowResourceTypes }}', -'{{ authenticate }}', -{{ bestAttempt }}, -'{{ cookies }}', -'{{ custom_ai }}', -'{{ emulateMediaType }}', -'{{ gotoOptions }}', -'{{ html }}', -'{{ prompt }}', -'{{ rejectRequestPattern }}', -'{{ rejectResourceTypes }}', -'{{ response_format }}', -'{{ setExtraHTTPHeaders }}', -{{ setJavaScriptEnabled }}, -'{{ userAgent }}', -'{{ viewport }}', -'{{ waitForSelector }}', -{{ waitForTimeout }}, -'{{ url }}', -'{{ account_id }}', -'{{ cacheTTL }}' -RETURNING -errors, -result, -success -; -``` - - - -{`# Description fields are for documentation purposes -- name: json - props: - - name: account_id - value: "{{ account_id }}" - description: Required parameter for the json resource. - - name: actionTimeout - value: {{ actionTimeout }} - description: | - The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. - - name: addScriptTag - description: | - Adds a \`