From f6e8bb58690f97e1c1618f5874f5de0baa42e7d8 Mon Sep 17 00:00:00 2001 From: claudespice Date: Thu, 7 May 2026 19:48:47 -0700 Subject: [PATCH 1/3] docs: Update NSQL API for optional model field, sample_data default, and tools auto mode Source: spiceai/spiceai#10715 --- website/docs/api/HTTP/post-nsql.api.mdx | 2 +- .../features/large-language-models/tools.md | 2 +- website/public/openapi.json | 19 +++++++++++++------ 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/website/docs/api/HTTP/post-nsql.api.mdx b/website/docs/api/HTTP/post-nsql.api.mdx index d9e301580..d139ad3de 100644 --- a/website/docs/api/HTTP/post-nsql.api.mdx +++ b/website/docs/api/HTTP/post-nsql.api.mdx @@ -59,7 +59,7 @@ When `stream` is true, the response is streamed as Server-Sent Events (SSE). diff --git a/website/docs/features/large-language-models/tools.md b/website/docs/features/large-language-models/tools.md index 40793bbaa..993be8302 100644 --- a/website/docs/features/large-language-models/tools.md +++ b/website/docs/features/large-language-models/tools.md @@ -21,7 +21,7 @@ The `tools` parameter on a model controls how tools are provided to the LLM: | Value | Description | | --- | --- | -| `auto` | Automatically choose between direct tools and searchable registry discovery. When the number of available tools exceeds 20 and an embedding model is available, `auto` switches to registry-based discovery; otherwise it uses direct tools. | +| `auto` | Automatically choose between direct tools and searchable registry discovery, excluding data sampling tools. When the number of available tools exceeds 20 and an embedding model is available, `auto` switches to registry-based discovery; otherwise it uses direct tools. | | `all` | Provide all built-in and Spicepod-configured tools directly to the LLM. | | `search_registry` | Use searchable registry discovery. The LLM receives `tool_search` and `tool_invoke` meta-tools instead of individual tool definitions. Requires an embedding model (see `tool_embedding_model`). | | `, , ...` | Provide only the named tools directly. | diff --git a/website/public/openapi.json b/website/public/openapi.json index 09c3dbabc..5ccdb990f 100644 --- a/website/public/openapi.json +++ b/website/public/openapi.json @@ -984,12 +984,12 @@ }, "example": { "query": "Get the top 5 customers by total sales", - "model": "nql", "stream": false, - "sample_data_enabled": true, + "sample_data_enabled": false, "datasets": [ "sales_data" - ] + ], + "prompt_cache_key": "sales-dashboard" } } }, @@ -1739,7 +1739,7 @@ "Tools" ], "summary": "Run Tool", - "description": "The request body and JSON response formats match the tool’s specification.", + "description": "The request body and JSON response formats match the tool\u2019s specification.", "operationId": "post", "parameters": [ { @@ -4808,7 +4808,7 @@ }, "model": { "type": "string", - "description": "The name of the model to use for SQL generation. Default: \"nql\"" + "description": "The name of the model to use for SQL generation. If omitted, Spice defaults to the only compatible LLM model configured in the Spicepod." }, "query": { "type": "string", @@ -4816,11 +4816,18 @@ }, "sample_data_enabled": { "type": "boolean", - "description": "Whether sample data is included in the context for SQL generation. Default: true" + "description": "Whether sample data is included in the context for SQL generation. Default: false" }, "stream": { "type": "boolean", "description": "If true, streams the response instead of waiting for completion" + }, + "prompt_cache_key": { + "type": [ + "string", + "null" + ], + "description": "Stable prompt-cache key forwarded to the configured NSQL model for provider-specific cache handling." } } }, From 757b10ebc7bdcaa6c37d481f7ea448792443b634 Mon Sep 17 00:00:00 2001 From: jeadie Date: Tue, 26 May 2026 08:46:21 +1000 Subject: [PATCH 2/3] fix: Add yaml dependency to resolve npm ci failure The postcss-load-config package (peer dep of tailwindcss) requires yaml@^2.4.2 as an optional peer dependency. npm 10 (used in CI) attempts to install optional peers and fails when yaml is not in the lock file. Adding yaml as a direct dependency resolves this. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- website/package-lock.json | 71 ++++++++++++++++++++++++++++++++++++--- website/package.json | 5 +-- 2 files changed, 69 insertions(+), 7 deletions(-) diff --git a/website/package-lock.json b/website/package-lock.json index e6cfe6f95..7df6d6257 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -36,7 +36,8 @@ "tailwind-merge": "^3.4.0", "tailwindcss": "^3.4.18", "tailwindcss-animate": "^1.0.7", - "workers-og": "^0.0.27" + "workers-og": "^0.0.27", + "yaml": "^2.9.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.8.1", @@ -19641,6 +19642,15 @@ "url": "https://github.com/Mermade/oas-kit?sponsor=1" } }, + "node_modules/oas-linter/node_modules/yaml": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, "node_modules/oas-resolver": { "version": "2.5.6", "resolved": "https://registry.npmjs.org/oas-resolver/-/oas-resolver-2.5.6.tgz", @@ -19680,6 +19690,24 @@ "url": "https://github.com/Mermade/oas-kit?sponsor=1" } }, + "node_modules/oas-resolver-browser/node_modules/yaml": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, + "node_modules/oas-resolver/node_modules/yaml": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, "node_modules/oas-schema-walker": { "version": "1.1.5", "resolved": "https://registry.npmjs.org/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz", @@ -19708,6 +19736,15 @@ "url": "https://github.com/Mermade/oas-kit?sponsor=1" } }, + "node_modules/oas-validator/node_modules/yaml": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", @@ -19957,6 +19994,15 @@ "node": ">=10" } }, + "node_modules/openapi-to-postmanv2/node_modules/yaml": { + "version": "1.10.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", + "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, "node_modules/opener": { "version": "1.5.2", "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", @@ -25461,6 +25507,15 @@ "url": "https://github.com/Mermade/oas-kit?sponsor=1" } }, + "node_modules/swagger2openapi/node_modules/yaml": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, "node_modules/swc-loader": { "version": "0.2.6", "resolved": "https://registry.npmjs.org/swc-loader/-/swc-loader-0.2.6.tgz", @@ -27503,12 +27558,18 @@ "license": "ISC" }, "node_modules/yaml": { - "version": "1.10.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", - "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", + "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==", "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, "engines": { - "node": ">= 6" + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" } }, "node_modules/yaml-ast-parser": { diff --git a/website/package.json b/website/package.json index 9e1e0e202..f48dbc780 100644 --- a/website/package.json +++ b/website/package.json @@ -43,7 +43,8 @@ "tailwind-merge": "^3.4.0", "tailwindcss": "^3.4.18", "tailwindcss-animate": "^1.0.7", - "workers-og": "^0.0.27" + "workers-og": "^0.0.27", + "yaml": "^2.9.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.8.1", @@ -67,4 +68,4 @@ "engines": { "node": ">=24.0" } -} \ No newline at end of file +} From 8c0fe4c8ca954d57986fd45542ee9a7e907962a8 Mon Sep 17 00:00:00 2001 From: Spice Schema Bot Date: Mon, 25 May 2026 22:48:06 +0000 Subject: [PATCH 3/3] chore: update API docs --- .../HTTP/generate-package.RequestSchema.json | 1 + .../HTTP/generate-package.StatusCodes.json | 1 + .../docs/api/HTTP/generate-package.api.mdx | 10 +- .../api/HTTP/get-catalogs.ParamsDetails.json | 1 + .../api/HTTP/get-catalogs.RequestSchema.json | 1 + .../api/HTTP/get-catalogs.StatusCodes.json | 1 + website/docs/api/HTTP/get-catalogs.api.mdx | 12 +- .../api/HTTP/get-config.RequestSchema.json | 1 + .../docs/api/HTTP/get-config.StatusCodes.json | 1 + website/docs/api/HTTP/get-config.api.mdx | 8 +- .../api/HTTP/get-datasets.ParamsDetails.json | 1 + .../api/HTTP/get-datasets.RequestSchema.json | 1 + .../api/HTTP/get-datasets.StatusCodes.json | 1 + website/docs/api/HTTP/get-datasets.api.mdx | 12 +- .../get-iceberg-namespaces.ParamsDetails.json | 1 + .../get-iceberg-namespaces.RequestSchema.json | 1 + .../get-iceberg-namespaces.StatusCodes.json | 1 + .../api/HTTP/get-iceberg-namespaces.api.mdx | 12 +- .../HTTP/get-model-predict.ParamsDetails.json | 1 + .../HTTP/get-model-predict.RequestSchema.json | 1 + .../HTTP/get-model-predict.StatusCodes.json | 1 + .../docs/api/HTTP/get-model-predict.api.mdx | 12 +- .../api/HTTP/get-models.ParamsDetails.json | 1 + .../api/HTTP/get-models.RequestSchema.json | 1 + .../docs/api/HTTP/get-models.StatusCodes.json | 1 + website/docs/api/HTTP/get-models.api.mdx | 12 +- .../api/HTTP/get-spicepods.ParamsDetails.json | 1 + .../api/HTTP/get-spicepods.RequestSchema.json | 1 + .../api/HTTP/get-spicepods.StatusCodes.json | 1 + website/docs/api/HTTP/get-spicepods.api.mdx | 12 +- .../api/HTTP/get-status.ParamsDetails.json | 1 + .../api/HTTP/get-status.RequestSchema.json | 1 + .../docs/api/HTTP/get-status.StatusCodes.json | 1 + website/docs/api/HTTP/get-status.api.mdx | 12 +- .../HTTP/head-namespace.RequestSchema.json | 1 + .../api/HTTP/head-namespace.StatusCodes.json | 1 + website/docs/api/HTTP/head-namespace.api.mdx | 8 +- website/docs/api/HTTP/list.RequestSchema.json | 1 + website/docs/api/HTTP/list.StatusCodes.json | 1 + website/docs/api/HTTP/list.api.mdx | 62 +++++ .../api/HTTP/mcp-event.ParamsDetails.json | 1 + .../api/HTTP/mcp-event.RequestSchema.json | 1 + .../docs/api/HTTP/mcp-event.StatusCodes.json | 1 + website/docs/api/HTTP/mcp-event.api.mdx | 18 +- .../api/HTTP/operation-id.RequestSchema.json | 1 + .../api/HTTP/operation-id.StatusCodes.json | 1 + website/docs/api/HTTP/operation-id.api.mdx | 22 +- ...ch-dataset-acceleration.ParamsDetails.json | 1 + ...ch-dataset-acceleration.RequestSchema.json | 1 + ...atch-dataset-acceleration.StatusCodes.json | 1 + .../HTTP/patch-dataset-acceleration.api.mdx | 146 ++++-------- .../post-batch-predict.RequestSchema.json | 1 + .../HTTP/post-batch-predict.StatusCodes.json | 1 + .../docs/api/HTTP/post-batch-predict.api.mdx | 10 +- .../post-chat-completions.RequestSchema.json | 1 + .../post-chat-completions.StatusCodes.json | 1 + .../api/HTTP/post-chat-completions.api.mdx | 10 +- .../post-dataset-refresh.ParamsDetails.json | 1 + .../post-dataset-refresh.RequestSchema.json | 1 + .../post-dataset-refresh.StatusCodes.json | 1 + .../api/HTTP/post-dataset-refresh.api.mdx | 12 +- .../HTTP/post-embeddings.RequestSchema.json | 1 + .../api/HTTP/post-embeddings.StatusCodes.json | 1 + website/docs/api/HTTP/post-embeddings.api.mdx | 10 +- .../api/HTTP/post-eval.ParamsDetails.json | 1 + .../api/HTTP/post-eval.RequestSchema.json | 1 + .../docs/api/HTTP/post-eval.StatusCodes.json | 1 + website/docs/api/HTTP/post-eval.api.mdx | 70 ++++++ .../api/HTTP/post-nsql.ParamsDetails.json | 1 + .../api/HTTP/post-nsql.RequestSchema.json | 1 + .../docs/api/HTTP/post-nsql.StatusCodes.json | 1 + website/docs/api/HTTP/post-nsql.api.mdx | 14 +- .../api/HTTP/post-search.RequestSchema.json | 1 + .../api/HTTP/post-search.StatusCodes.json | 1 + website/docs/api/HTTP/post-search.api.mdx | 10 +- .../docs/api/HTTP/post-sql.ParamsDetails.json | 1 + .../docs/api/HTTP/post-sql.RequestSchema.json | 1 + .../docs/api/HTTP/post-sql.StatusCodes.json | 1 + website/docs/api/HTTP/post-sql.api.mdx | 215 ++++-------------- website/docs/api/HTTP/post.ParamsDetails.json | 1 + website/docs/api/HTTP/post.RequestSchema.json | 1 + website/docs/api/HTTP/post.StatusCodes.json | 1 + website/docs/api/HTTP/post.api.mdx | 12 +- website/docs/api/HTTP/ready.api.mdx | 2 +- website/docs/api/HTTP/sidebar.ts | 24 ++ 85 files changed, 408 insertions(+), 399 deletions(-) create mode 100644 website/docs/api/HTTP/generate-package.RequestSchema.json create mode 100644 website/docs/api/HTTP/generate-package.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-catalogs.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-catalogs.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-catalogs.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-config.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-config.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-datasets.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-datasets.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-datasets.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-iceberg-namespaces.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-iceberg-namespaces.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-iceberg-namespaces.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-model-predict.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-model-predict.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-model-predict.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-models.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-models.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-models.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-spicepods.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-spicepods.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-spicepods.StatusCodes.json create mode 100644 website/docs/api/HTTP/get-status.ParamsDetails.json create mode 100644 website/docs/api/HTTP/get-status.RequestSchema.json create mode 100644 website/docs/api/HTTP/get-status.StatusCodes.json create mode 100644 website/docs/api/HTTP/head-namespace.RequestSchema.json create mode 100644 website/docs/api/HTTP/head-namespace.StatusCodes.json create mode 100644 website/docs/api/HTTP/list.RequestSchema.json create mode 100644 website/docs/api/HTTP/list.StatusCodes.json create mode 100644 website/docs/api/HTTP/list.api.mdx create mode 100644 website/docs/api/HTTP/mcp-event.ParamsDetails.json create mode 100644 website/docs/api/HTTP/mcp-event.RequestSchema.json create mode 100644 website/docs/api/HTTP/mcp-event.StatusCodes.json create mode 100644 website/docs/api/HTTP/operation-id.RequestSchema.json create mode 100644 website/docs/api/HTTP/operation-id.StatusCodes.json create mode 100644 website/docs/api/HTTP/patch-dataset-acceleration.ParamsDetails.json create mode 100644 website/docs/api/HTTP/patch-dataset-acceleration.RequestSchema.json create mode 100644 website/docs/api/HTTP/patch-dataset-acceleration.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-batch-predict.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-batch-predict.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-chat-completions.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-chat-completions.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-dataset-refresh.ParamsDetails.json create mode 100644 website/docs/api/HTTP/post-dataset-refresh.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-dataset-refresh.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-embeddings.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-embeddings.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-eval.ParamsDetails.json create mode 100644 website/docs/api/HTTP/post-eval.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-eval.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-eval.api.mdx create mode 100644 website/docs/api/HTTP/post-nsql.ParamsDetails.json create mode 100644 website/docs/api/HTTP/post-nsql.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-nsql.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-search.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-search.StatusCodes.json create mode 100644 website/docs/api/HTTP/post-sql.ParamsDetails.json create mode 100644 website/docs/api/HTTP/post-sql.RequestSchema.json create mode 100644 website/docs/api/HTTP/post-sql.StatusCodes.json create mode 100644 website/docs/api/HTTP/post.ParamsDetails.json create mode 100644 website/docs/api/HTTP/post.RequestSchema.json create mode 100644 website/docs/api/HTTP/post.StatusCodes.json diff --git a/website/docs/api/HTTP/generate-package.RequestSchema.json b/website/docs/api/HTTP/generate-package.RequestSchema.json new file mode 100644 index 000000000..b1426b239 --- /dev/null +++ b/website/docs/api/HTTP/generate-package.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Parameters required to generate a package","content":{"application/json":{"schema":{"type":"object","required":["from","params"],"properties":{"from":{"type":"string","description":"The GitHub source path in the format `github:{org}/{repo}/{sha}/{path_to_spicepod.yaml}`"},"params":{"type":"object","description":"A key-value map of optional parameters (e.g., `github_token`)","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}}},"title":"GeneratePackageRequest"},"example":{"from":"github:myorg/myrepo/abc12345/spicepod.yaml","params":{"github_token":"ghp_exampleToken12345"}}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/generate-package.StatusCodes.json b/website/docs/api/HTTP/generate-package.StatusCodes.json new file mode 100644 index 000000000..e7fee817a --- /dev/null +++ b/website/docs/api/HTTP/generate-package.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Package generated successfully","content":{"application/zip":{"schema":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}},"example":""}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{},"example":{"error":"Invalid `from` field, specify a github source and retry (e.g. github:{org}/{repo}/{sha}/{path_to_spicepod.yaml})"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/generate-package.api.mdx b/website/docs/api/HTTP/generate-package.api.mdx index 6d5e658ae..6154cfa48 100644 --- a/website/docs/api/HTTP/generate-package.api.mdx +++ b/website/docs/api/HTTP/generate-package.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request "}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{},"example":{"error":"Invalid `from` field, specify a github source and retry (e.g. github:{org}/{repo}/{sha}/{path_to_spicepod.yaml})"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred"}}}}}} + {...require("./generate-package.StatusCodes.json")} > diff --git a/website/docs/api/HTTP/get-catalogs.ParamsDetails.json b/website/docs/api/HTTP/get-catalogs.ParamsDetails.json new file mode 100644 index 000000000..09e6aa37d --- /dev/null +++ b/website/docs/api/HTTP/get-catalogs.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"from","in":"query","description":"Filters catalogs by source (e.g., 'spiceai').","required":false,"schema":{"type":["string","null"]}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-catalogs.RequestSchema.json b/website/docs/api/HTTP/get-catalogs.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-catalogs.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-catalogs.StatusCodes.json b/website/docs/api/HTTP/get-catalogs.StatusCodes.json new file mode 100644 index 000000000..f11f3f6dc --- /dev/null +++ b/website/docs/api/HTTP/get-catalogs.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of catalogs","content":{"application/json":{"schema":{"type":"object","required":["from","name"],"properties":{"from":{"type":"string"},"name":{"type":"string"}},"title":"CatalogResponseItem"},"example":[{"from":"spiceai","name":"spiceai"}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name\nspiceai,spiceai\n"}}},"500":{"description":"Internal server error occurred while processing catalogs","content":{"application/json":{"schema":{},"example":{"error":"An unexpected error occurred while processing the catalogs"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-catalogs.api.mdx b/website/docs/api/HTTP/get-catalogs.api.mdx index 529c62b46..8392d65b2 100644 --- a/website/docs/api/HTTP/get-catalogs.api.mdx +++ b/website/docs/api/HTTP/get-catalogs.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/get-config.RequestSchema.json b/website/docs/api/HTTP/get-config.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-config.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-config.StatusCodes.json b/website/docs/api/HTTP/get-config.StatusCodes.json new file mode 100644 index 000000000..7fa111c57 --- /dev/null +++ b/website/docs/api/HTTP/get-config.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"API configuration retrieved successfully","content":{"application/json":{"schema":{},"example":{"overrides":{},"defaults":{},"endpoints":["GET /v1/iceberg/namespaces","HEAD /v1/iceberg/namespaces/{namespace}","GET /v1/iceberg/namespaces/{namespace}/tables","HEAD /v1/iceberg/namespaces/{namespace}/tables/{table}","GET /v1/iceberg/namespaces/{namespace}/tables/{table}"]}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-config.api.mdx b/website/docs/api/HTTP/get-config.api.mdx index 0916140b4..bdd825c66 100644 --- a/website/docs/api/HTTP/get-config.api.mdx +++ b/website/docs/api/HTTP/get-config.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; diff --git a/website/docs/api/HTTP/get-datasets.ParamsDetails.json b/website/docs/api/HTTP/get-datasets.ParamsDetails.json new file mode 100644 index 000000000..a4c6c0206 --- /dev/null +++ b/website/docs/api/HTTP/get-datasets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"status","in":"query","description":"Whether to include the status field in the response. When `true`, the response includes\nthe current status of each dataset (e.g., `ready`, `initializing`, `refreshing`, `error`).\nDefaults to `false`.","required":false,"schema":{"type":"boolean"}},{"name":"format","in":"query","description":"The format of the response. Possible values are 'json' (default) or 'csv'.","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}},{"name":"source","in":"query","description":"Filters datasets by source (e.g., `postgres:aidemo_messages`).","required":false,"schema":{"type":["string","null"]}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-datasets.RequestSchema.json b/website/docs/api/HTTP/get-datasets.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-datasets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-datasets.StatusCodes.json b/website/docs/api/HTTP/get-datasets.StatusCodes.json new file mode 100644 index 000000000..35f2555c9 --- /dev/null +++ b/website/docs/api/HTTP/get-datasets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of datasets. When `status=true` is specified, each dataset includes a `status` field.","content":{"application/json":{"schema":{"type":"object","required":["from","name","replication_enabled","acceleration_enabled"],"properties":{"acceleration_enabled":{"type":"boolean","description":"Whether acceleration is enabled for the dataset"},"from":{"type":"string","description":"The source where the dataset is located"},"name":{"type":"string","description":"The name of the dataset"},"properties":{"type":"object","description":"Custom properties for the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"replication_enabled":{"type":"boolean","description":"Whether replication is enabled for the dataset"},"status":{"oneOf":[{"type":"null"},{"description":"The current status of the dataset. Only included when `status=true` query parameter is specified.\nPossible values: `initializing`, `ready`, `disabled`, `error`, `refreshing`, `shuttingdown`.","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}]}},"title":"DatasetResponseItem"},"example":[{"from":"postgres:syncs","name":"daily_journal_accelerated","replication_enabled":false,"acceleration_enabled":true,"status":"Ready"},{"from":"databricks:hive_metastore.default.messages","name":"messages_accelerated","replication_enabled":false,"acceleration_enabled":true,"status":"Refreshing"},{"from":"postgres:aidemo_messages","name":"general","replication_enabled":false,"acceleration_enabled":false,"status":"Initializing"}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name,replication_enabled,acceleration_enabled,status\npostgres:syncs,daily_journal_accelerated,false,true,Ready\ndatabricks:hive_metastore.default.messages,messages_accelerated,false,true,Refreshing\npostgres:aidemo_messages,general,false,false,Initializing\n"}}},"500":{"description":"Internal server error occurred while processing datasets","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing datasets"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-datasets.api.mdx b/website/docs/api/HTTP/get-datasets.api.mdx index 3abdf05b5..95872d2cf 100644 --- a/website/docs/api/HTTP/get-datasets.api.mdx +++ b/website/docs/api/HTTP/get-datasets.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/get-iceberg-namespaces.ParamsDetails.json b/website/docs/api/HTTP/get-iceberg-namespaces.ParamsDetails.json new file mode 100644 index 000000000..c81e7c8b4 --- /dev/null +++ b/website/docs/api/HTTP/get-iceberg-namespaces.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"parent","in":"query","description":"The parent namespace from which to retrieve child namespaces.","required":false,"schema":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-iceberg-namespaces.RequestSchema.json b/website/docs/api/HTTP/get-iceberg-namespaces.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-iceberg-namespaces.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-iceberg-namespaces.StatusCodes.json b/website/docs/api/HTTP/get-iceberg-namespaces.StatusCodes.json new file mode 100644 index 000000000..6d7846735 --- /dev/null +++ b/website/docs/api/HTTP/get-iceberg-namespaces.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Namespaces retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["namespaces"],"properties":{"namespaces":{"type":"array","items":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}},"title":"NamespacesResponse"},"example":{"namespaces":[{"parts":["catalog_a"]},{"parts":["catalog_b","schema_1"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Invalid namespace request","type":"BadRequestException","code":400}}}}},"404":{"description":"Namespace not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Namespace provided does not exist","type":"NoSuchNamespaceException","code":404}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Internal Server Error: DF_SCHEMA_NOT_FOUND","type":"InternalServerError","code":500}}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-iceberg-namespaces.api.mdx b/website/docs/api/HTTP/get-iceberg-namespaces.api.mdx index 89c1e39d0..ba2a5d951 100644 --- a/website/docs/api/HTTP/get-iceberg-namespaces.api.mdx +++ b/website/docs/api/HTTP/get-iceberg-namespaces.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/get-model-predict.ParamsDetails.json b/website/docs/api/HTTP/get-model-predict.ParamsDetails.json new file mode 100644 index 000000000..5cbd28ce9 --- /dev/null +++ b/website/docs/api/HTTP/get-model-predict.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"path","description":"The name of the model to make a prediction with.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-model-predict.RequestSchema.json b/website/docs/api/HTTP/get-model-predict.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-model-predict.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-model-predict.StatusCodes.json b/website/docs/api/HTTP/get-model-predict.StatusCodes.json new file mode 100644 index 000000000..90dc801da --- /dev/null +++ b/website/docs/api/HTTP/get-model-predict.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Prediction made successfully","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"Success","model_name":"my_model_name","model_version":"1.0","prediction":[0.45,0.5,0.55],"duration_ms":123}}}},"400":{"description":"Invalid request to the model","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"BadRequest","error_message":"You gave me a bad request :(","model_name":"my_model_name","duration_ms":12}}}},"500":{"description":"Internal server error occurred during prediction","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"InternalError","error_message":"Oops, the server couldn't predict","model_name":"my_model_name","duration_ms":12}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-model-predict.api.mdx b/website/docs/api/HTTP/get-model-predict.api.mdx index ae93a5ccf..7130f07a8 100644 --- a/website/docs/api/HTTP/get-model-predict.api.mdx +++ b/website/docs/api/HTTP/get-model-predict.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/get-models.ParamsDetails.json b/website/docs/api/HTTP/get-models.ParamsDetails.json new file mode 100644 index 000000000..a060627c4 --- /dev/null +++ b/website/docs/api/HTTP/get-models.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"format","in":"query","description":"The format of the response (e.g., `json` or `csv`).","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}},{"name":"status","in":"query","description":"If true, includes the status of each model in the response.","required":false,"schema":{"type":"boolean"}},{"name":"metadata_fields","in":"query","description":"A comma-separated list of metadata fields to include in the response (e.g., `supports_responses_api`)","required":false,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-models.RequestSchema.json b/website/docs/api/HTTP/get-models.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-models.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-models.StatusCodes.json b/website/docs/api/HTTP/get-models.StatusCodes.json new file mode 100644 index 000000000..0b42529a0 --- /dev/null +++ b/website/docs/api/HTTP/get-models.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of models in JSON format","content":{"application/json":{"schema":{"type":"object","required":["object","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","object","owned_by"],"properties":{"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated with this model, if any"},"id":{"type":"string","description":"The name of the model"},"metadata":{"oneOf":[{"type":"null"},{"type":"object","required":["supports_responses_api"],"properties":{"supports_responses_api":{"type":"boolean"}},"title":"Metadata"}]},"object":{"type":"string","description":"The type of the model (always `model`)"},"owned_by":{"type":"string","description":"The source from which the model was loaded (e.g., `openai`, `spiceai`)"},"status":{"oneOf":[{"type":"null"},{"description":"The status of the model (e.g., `ready`, `initializing`, `error`)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}]}},"title":"OpenAIModel"}},"object":{"type":"string"}},"title":"OpenAIModelResponse"},"example":{"object":"list","data":[{"id":"gpt-4","object":"model","owned_by":"openai","datasets":null,"status":"ready"},{"id":"text-embedding-ada-002","object":"model","owned_by":"openai-internal","datasets":["text-dataset-1","text-dataset-2"],"status":"ready"}]}},"text/csv":{"schema":{"type":"string"},"example":"\nid,object,owned_by,datasets,status\ngpt-4,model,openai,,ready\ntext-embedding-ada-002,model,openai-internal,\"text-dataset-1,text-dataset-2\",ready\n"}}},"500":{"description":"Internal server error occurred while processing models","content":{"application/json":{"schema":{},"example":{"error":"App not initialized"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-models.api.mdx b/website/docs/api/HTTP/get-models.api.mdx index 0930a7355..de05eb5a7 100644 --- a/website/docs/api/HTTP/get-models.api.mdx +++ b/website/docs/api/HTTP/get-models.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/get-spicepods.ParamsDetails.json b/website/docs/api/HTTP/get-spicepods.ParamsDetails.json new file mode 100644 index 000000000..620ed37b0 --- /dev/null +++ b/website/docs/api/HTTP/get-spicepods.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"format","in":"query","description":"The format of the response. Possible values are 'json' (default) or 'csv'.","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-spicepods.RequestSchema.json b/website/docs/api/HTTP/get-spicepods.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-spicepods.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-spicepods.StatusCodes.json b/website/docs/api/HTTP/get-spicepods.StatusCodes.json new file mode 100644 index 000000000..d23c4a54d --- /dev/null +++ b/website/docs/api/HTTP/get-spicepods.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of spicepods","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","version"],"properties":{"datasets_count":{"type":"integer","description":"The number of datasets in this spicepod","minimum":0},"dependencies_count":{"type":"integer","description":"The number of dependencies in this spicepod","minimum":0},"models_count":{"type":"integer","description":"The number of models in this spicepod","minimum":0},"name":{"type":"string","description":"The name of the spicepod"},"version":{"type":"string","description":"The version of the spicepod"}},"title":"SpicepodSummary"}},"example":[{"name":"spicepod1","version":"v1.0.0","datasets_count":3,"models_count":2,"dependencies_count":5},{"name":"spicepod2","version":"v2.0.0","datasets_count":4,"models_count":3,"dependencies_count":2}]},"text/csv":{"schema":{"type":"string"},"example":"name,version,datasets_count,models_count,dependencies_count\nspicepod1,v1.0.0,3,2,5\nspicepod2,v2.0.0,4,3,2"}}},"500":{"description":"Internal server error","content":{"text/plain":{"schema":{"type":"string"},"example":"Internal server error"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-spicepods.api.mdx b/website/docs/api/HTTP/get-spicepods.api.mdx index 253103f77..a29164cd1 100644 --- a/website/docs/api/HTTP/get-spicepods.api.mdx +++ b/website/docs/api/HTTP/get-spicepods.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/get-status.ParamsDetails.json b/website/docs/api/HTTP/get-status.ParamsDetails.json new file mode 100644 index 000000000..175653ca5 --- /dev/null +++ b/website/docs/api/HTTP/get-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"format","in":"query","description":"The format of the response, either \"json\" or \"csv\". Defaults to \"json\".","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-status.RequestSchema.json b/website/docs/api/HTTP/get-status.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/get-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-status.StatusCodes.json b/website/docs/api/HTTP/get-status.StatusCodes.json new file mode 100644 index 000000000..3e18b6e31 --- /dev/null +++ b/website/docs/api/HTTP/get-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of connection statuses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","endpoint","status"],"properties":{"endpoint":{"type":"string","description":"The endpoint of the connection (e.g., URL or IP address)"},"name":{"type":"string","description":"The name of the connection (e.g., \"http\", \"flight\", \"metrics\", \"opentelemetry\")"},"status":{"description":"The status of the component (e.g., Ready, Initializing, Disabled, Error, etc.)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}},"title":"ConnectionDetails"}},"example":[{"name":"http","endpoint":"http://127.0.0.1:8080","status":"Ready"},{"name":"flight","endpoint":"http://127.0.0.1:9000","status":"Initializing"},{"name":"metrics","endpoint":"N/A","status":"Disabled"},{"name":"opentelemetry","endpoint":"http://127.0.0.1:4317","status":"Error"}]},"text/csv":{"schema":{"type":"string"},"example":"name,endpoint,status\nhttp,http://127.0.0.1:8080,Ready\nflight,http://127.0.0.1:9000,Initializing\nmetrics,N/A,Disabled\nopentelemetry,http://127.0.0.1:4317,Error"}}},"500":{"description":"Error converting to CSV","content":{"text/plain":{"schema":{"type":"string"},"example":"Error converting to CSV"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/get-status.api.mdx b/website/docs/api/HTTP/get-status.api.mdx index dfc9bda55..e9b84505b 100644 --- a/website/docs/api/HTTP/get-status.api.mdx +++ b/website/docs/api/HTTP/get-status.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/head-namespace.RequestSchema.json b/website/docs/api/HTTP/head-namespace.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/head-namespace.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/head-namespace.StatusCodes.json b/website/docs/api/HTTP/head-namespace.StatusCodes.json new file mode 100644 index 000000000..9af0e5af4 --- /dev/null +++ b/website/docs/api/HTTP/head-namespace.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Namespace exists"},"404":{"description":"Namespace does not exist"}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/head-namespace.api.mdx b/website/docs/api/HTTP/head-namespace.api.mdx index 9afc91684..ef7475786 100644 --- a/website/docs/api/HTTP/head-namespace.api.mdx +++ b/website/docs/api/HTTP/head-namespace.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; diff --git a/website/docs/api/HTTP/list.RequestSchema.json b/website/docs/api/HTTP/list.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/list.StatusCodes.json b/website/docs/api/HTTP/list.StatusCodes.json new file mode 100644 index 000000000..7173a4939 --- /dev/null +++ b/website/docs/api/HTTP/list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"All evals available in the Spice runtime","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","dataset","scorers"],"properties":{"dataset":{"type":"string"},"description":{"type":["string","null"]},"name":{"type":"string"},"scorers":{"type":"array","items":{"type":"string"}}},"title":"ListEvalElement"}},"example":[{"name":"knows_math","description":"Questions from first year, undergraduate math exams","dataset":"math_exams","scorers":["match","professor_logical_consistency"]}]}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/list.api.mdx b/website/docs/api/HTTP/list.api.mdx new file mode 100644 index 000000000..4bb5691c3 --- /dev/null +++ b/website/docs/api/HTTP/list.api.mdx @@ -0,0 +1,62 @@ +--- +id: list +title: "List Evals" +description: "Return all evals available to run in the runtime." +sidebar_label: "List Evals" +hide_title: true +hide_table_of_contents: true +api: eJydVMtu2zAQ/BViz/Irp1a3oDCKArm0TU+G4WyotcWEIhlypcQQ9O/FUrLruAEK9CRqV5rhzgzZA+MhQbmBdYe2RTbeJdgWUFHS0QR5hxJ+ELfRKbRWUYc2KezQWHy0pNir2DplnOKaZMmmoTkU4APFjPetghKsSQwFRErBu0QJyh5ulkt5vKe6/YBjAv8ZjD5TQAHaOybHgoEhWKMz3eIpCVAPSdfUoKz4GAhKwBjxCAUYpiZd1P3jE+lxdy+tiVSJHg4zR4WMiaSZtI8UszghynBsxjFOn/wBTByNO8BwJeOpvzl9UIBrrYXtUIx0HyGcaP89xumfYSiADVup3ZnE4uzaUiNSSY/esAnS3fQTLTw7/5p2DXIN19Z/bynlVKh99I3am5hYHQljoVpXUTxErFpkUvK3Eux0IVsJUt6dyudhNlLXwhai31NKPu6sPxiNdqe9SyYxOX2E7bAd8kANce0lSIdsRpCtlrDoVoscFsGm2I3YPbTRQgk1cygXC+s12tonLj8tPy//GvBO2qqijqwPIpIakebqi3d7c2gjqVfDtXqYzQTxYQ7DVuh0Gw0fMx8Gs3smWW+lZ9zeZ2MmF/5E9j31fU0qSairi1Rbo8mlHIbJnduAuqbZzVw2bypybPaG4vvOUICMPwKv5qvVfDlrXWI5QNIMPnGD7gJWsqHWk3pXQT0frf86+lMgmd54ESwaJxvInvSTcxvoVlDA6N22ALFHqn3/iIl+RTsMUn5pKWZVC+gwmjyLaFxATViJBJsesvBwqzUFiYbcY/mYXF8J4sw5Rl/X9zAMvwGYMrjk +sidebar_class_name: "get api-method" +info_path: docs/api/HTTP/runtime +custom_edit_url: null +proxy: http://localhost:8090 +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Return all evals available to run in the runtime. + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/HTTP/mcp-event.ParamsDetails.json b/website/docs/api/HTTP/mcp-event.ParamsDetails.json new file mode 100644 index 000000000..914110a30 --- /dev/null +++ b/website/docs/api/HTTP/mcp-event.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"query","required":true}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/mcp-event.RequestSchema.json b/website/docs/api/HTTP/mcp-event.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/mcp-event.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/mcp-event.StatusCodes.json b/website/docs/api/HTTP/mcp-event.StatusCodes.json new file mode 100644 index 000000000..15aa2c9dc --- /dev/null +++ b/website/docs/api/HTTP/mcp-event.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Message accepted. Response will stream via SSE."},"404":{"description":"Session not found. No active session for the given `session_id`."},"413":{"description":"Payload too large. Maximum allowed size is 4MB."},"500":{"description":"Internal server error. An unexpected issue occurred."}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/mcp-event.api.mdx b/website/docs/api/HTTP/mcp-event.api.mdx index 48518ae9d..bb242e17d 100644 --- a/website/docs/api/HTTP/mcp-event.api.mdx +++ b/website/docs/api/HTTP/mcp-event.api.mdx @@ -1,7 +1,7 @@ --- id: mcp-event title: "Send message to MCP server" -description: "Send a message to the MCP endpoint for a given session. Include the Mcp-Session-Id header to identify the session." +description: "Send message to the MCP endoint, for a given session." sidebar_label: "Send message to MCP server" hide_title: true hide_table_of_contents: true @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; @@ -37,33 +38,30 @@ import Heading from "@theme/Heading"; -Send a message to the MCP endpoint for a given session. Include the `Mcp-Session-Id` header to identify the session. +Send message to the MCP endoint, for a given session. + Request diff --git a/website/docs/api/HTTP/operation-id.RequestSchema.json b/website/docs/api/HTTP/operation-id.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/website/docs/api/HTTP/operation-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/website/docs/api/HTTP/operation-id.StatusCodes.json b/website/docs/api/HTTP/operation-id.StatusCodes.json new file mode 100644 index 000000000..bfc5cbb0c --- /dev/null +++ b/website/docs/api/HTTP/operation-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{}} \ No newline at end of file diff --git a/website/docs/api/HTTP/operation-id.api.mdx b/website/docs/api/HTTP/operation-id.api.mdx index 0dbd32d4d..de237992d 100644 --- a/website/docs/api/HTTP/operation-id.api.mdx +++ b/website/docs/api/HTTP/operation-id.api.mdx @@ -1,8 +1,8 @@ --- id: operation-id -title: "Establish an MCP Streamable HTTP Connection" -description: "Initiates a Streamable HTTP connection using the Model Context Protocol (MCP) to interact with Spice tools." -sidebar_label: "Establish an MCP Streamable HTTP Connection" +title: "Establish an MCP SSE Connection" +description: "Initiates a Server-Sent Events (SSE) connection using the Model Context Protocol (MCP) to interact with Spice tools." +sidebar_label: "Establish an MCP SSE Connection" hide_title: true hide_table_of_contents: true api: eJzlU8Fu2zAM/RWCpxZwnGanzbchCIYCKxrA2akLGlVmYmKypEm0t8Lwvw90tjbrPmHWxdYT36Men0cUc8pYPWBnI+4LbCjbxFE4eKzw1rOwEcpgoKY0UFrU5AU2A3nJcFXXm2uwwXuyWgF9Zn8CaQnuQkMO1sEL/RTYpiDBBgdXd+vtNUgA9kLJWIEfLC3UkS2BhOBy+dXrgsvn3lv6I0NNAdbxrG+Nh0y+gY5yNifKMLCBw/a+3sFyWC07G5c50wGMbyCRJR4IEuUYfKYM0qbQn1qQljPU9QayJDJdiQWGSMnolW4brF6/HrnBAl8YsBqnAjuSNuixEwkWGI20WOGFPhaYZ/PU6BH75LDCViRWy6UL1rg2ZKne33y4wbcD+KwwNDSQC7FT689MpVp75FOf6OzgYbFQxkOJ017lbJ9Ynmc9E/nxG+n7XjH2x4DViMLiCCtMvRfu6B/pXUuQdS4NvB5xbMln0npvOi3/GI1tafGu1Oa5IS98ZEp/I1OBev0z8apcrcqbRe+zmCdHCsaQpTP+gnYzg5xbMB7u1tt5PuuXpL3tdkSrUfPyP4dWnqNap80vozPs1do5bePvVD7gsMJi/tcL1GTuC9TwKTKOTybTl+SmSbe/95TmzBQ4mMTzpDRBF3n/tNnhNP0CfeNyCQ== @@ -19,17 +19,18 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; @@ -37,10 +38,10 @@ import Heading from "@theme/Heading"; -Initiates a Streamable HTTP connection using the Model Context Protocol (MCP) to interact with Spice tools. +Initiates a Server-Sent Events (SSE) connection using the Model Context Protocol (MCP) to interact with Spice tools. - Once connected, clients can send messages via `POST /v1/mcp` with an `Mcp-Session-Id` header and receive responses through this stream. + Once connected, clients can send messages via `POST /v1/mcp/sse` and receive responses through this SSE stream. diff --git a/website/docs/api/HTTP/patch-dataset-acceleration.ParamsDetails.json b/website/docs/api/HTTP/patch-dataset-acceleration.ParamsDetails.json new file mode 100644 index 000000000..f06180a73 --- /dev/null +++ b/website/docs/api/HTTP/patch-dataset-acceleration.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"path","description":"The name of the dataset to update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/patch-dataset-acceleration.RequestSchema.json b/website/docs/api/HTTP/patch-dataset-acceleration.RequestSchema.json new file mode 100644 index 000000000..3946b469d --- /dev/null +++ b/website/docs/api/HTTP/patch-dataset-acceleration.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"The updated SQL statement for the dataset's refresh.","content":{"application/json":{"schema":{"type":"object","properties":{"refresh_sql":{"type":["string","null"],"description":"SQL statement used for the refresh. Defaults to the `refresh_sql` specified in the spicepod."}},"title":"AccelerationRequest"},"example":{"refresh_sql":"SELECT * FROM eth_recent_blocks WHERE block_number > 100"}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/patch-dataset-acceleration.StatusCodes.json b/website/docs/api/HTTP/patch-dataset-acceleration.StatusCodes.json new file mode 100644 index 000000000..65446eab8 --- /dev/null +++ b/website/docs/api/HTTP/patch-dataset-acceleration.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The refresh SQL was updated successfully."},"404":{"description":"The specified dataset was not found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset eth_recent_blocks not found"}}}},"500":{"description":"An internal server error occurred while updating the refresh SQL","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Request failed. An internal server error occurred while updating refresh SQL."}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/patch-dataset-acceleration.api.mdx b/website/docs/api/HTTP/patch-dataset-acceleration.api.mdx index 4fe80a6ad..f28ee25b1 100644 --- a/website/docs/api/HTTP/patch-dataset-acceleration.api.mdx +++ b/website/docs/api/HTTP/patch-dataset-acceleration.api.mdx @@ -1,125 +1,73 @@ --- id: patch-dataset-acceleration -title: 'Update Refresh SQL' +title: "Update Refresh SQL" description: "Update the refresh SQL for a dataset's acceleration." -sidebar_label: 'Update Refresh SQL' +sidebar_label: "Update Refresh SQL" hide_title: true hide_table_of_contents: true api: eJztVt9v2zYQ/leIe+kWKLJddMCmhwJZmqEDUmxzU/QhNRxaPFtsKVIhT3YMQf/7cJTkH7EXbNjj5hdL4vH48fvuPrIBkqsA2T28kyQDUoBZAgpD7nVF2lnI4FOlJKGgAoXHpcdQiI9/3Iql80IK1U17FYTMczToJc9Kv9gv9q7QQaBVldOWhDTGbUKcVXNCbVcx5UOfcx4ezYOopJclEvoX0wtJwteWdIkpr4MiL6RdodBBXFwQlpXz0m8vLoS0Smy0McLjGj0Jct2iodI5Vk6l29I8CIVLbfWQmQMsPu2WEB4DSU8pJOCqHsKvCjKoJOXFvMc4P0QICey2wvQ2YGWJkHV/CWjbTS/gOdu8Gw4SbhmR9NkZeeQNGYbHx1p7VJCRrzGBkBdYSsgaoG3FywTy2q6gbWddMAb62aktR5wu1+VVUdVAkrBES1GAAwCvwqA+A8idJbTE+WRVGZ3HXY++Bk7anOJxi6+YE7PimULSGHj0QPt98P2APgFbG3NakMc464BqB3aAKN7hUtaGwk7xozILFeZ6qVEJbePwrh6gbRMgTYZRXx0oOu1YhDYBfJJlxQHPNgAfb25vru/Ehfhl+tsHgVTMPeZoab4wLv8WxOf3N9MbEV/mti4X6MVbMRmPoeVVj0WNH0LlbOioej0en1fvsCc3MuzUDHWeYwjL2phtyrDfjN+cz7BnYyg2zmMd10Bt1b+Re7+neygxBLlC1vO4CoaBk/I91xt9sOhGFoONeAy1oaFp/CDWgZgfuonTntRnQu4wDEZ4Rr49I20U7IdzklxZoS2ht9KIgH6NXqD3zguX57X3qMSm0AaPTfBAw/8Y231biaXUBlUq/jF9B9SlUZc2gRKpcDuDjl5MBWQwWk9GfYmHUcMu246euXa3ZmfZteemLoiqbDQyLpemcIGyH8c/jU/IuuVhoXCNxlXRl7pMqbh2dqlXtUex0VSIh8tLzviQAntzwLz2mrZxPVnp+Tfk5xmPsd7TvXff/JXrDF7Pp8rSRV17EfoD7Kyy0fGU2IcYnSMrle3OqqtK5gVevk55u1qhJXYJfzzSJsCEdYkn6WSSji9rG0guTFS9coFKaQ/S9veJ6VHNHwFs9i3w/+3j4PbR9yvhE40qI7VlgmOVNn2J38N6wmwOl7kEsv7GcVTnswS4lDm+aRYy4Cdv2pY/P9boYwUmsJZeRxW5NpUO/KwgW0oT8AXBvpv2LvS9+Ft3mbOb6j9KuwUGYmp+gwRie3SF1M7aBAqUiivyvumHrjscl3ecYD/1xEfbZJjBh3xFL8bODizl96u76/eQwKK/TpVOxVaTGzZguelwukhMd8fhbw0YaVd153ldUv79CfhKCg4= -sidebar_class_name: 'patch api-method' +sidebar_class_name: "patch api-method" info_path: docs/api/HTTP/runtime custom_edit_url: null proxy: http://localhost:8090 --- -import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint' -import ParamsDetails from '@theme/ParamsDetails' -import RequestSchema from '@theme/RequestSchema' -import StatusCodes from '@theme/StatusCodes' -import OperationTabs from '@theme/OperationTabs' -import TabItem from '@theme/TabItem' -import Heading from '@theme/Heading' +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + + method={"patch"} + path={"/v1/datasets/{name}/acceleration"} + context={"endpoint"} +> + + + + Update the refresh SQL for a dataset's acceleration. -This endpoint updates the `refresh_sql` parameter for a dataset's acceleration at runtime. +This endpoint allows for updating the `refresh_sql` parameter for a dataset's acceleration at runtime. The change is **temporary** and will revert to the `spicepod.yml` definition at the next runtime restart. + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} +> + Request + + {...require("./patch-dataset-acceleration.ParamsDetails.json")} +> + + 100' } - } - }, - required: true - }} -> + {...require("./patch-dataset-acceleration.RequestSchema.json")} +> + + + {...require("./patch-dataset-acceleration.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/website/docs/api/HTTP/post-batch-predict.RequestSchema.json b/website/docs/api/HTTP/post-batch-predict.RequestSchema.json new file mode 100644 index 000000000..7aff0a1bb --- /dev/null +++ b/website/docs/api/HTTP/post-batch-predict.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Batch prediction request containing a list of prediction requests for specific models","content":{"application/json":{"schema":{"type":"object","properties":{"predictions":{"type":"array","items":{"type":"object","required":["model_name"],"properties":{"model_name":{"type":"string"}},"title":"PredictRequest"},"description":"The list of prediction requests, each specifying the model to use for the prediction"}},"title":"BatchPredictRequest"},"example":{"predictions":[{"model_name":"drive_stats_a"},{"model_name":"drive_stats_b"}]}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-batch-predict.StatusCodes.json b/website/docs/api/HTTP/post-batch-predict.StatusCodes.json new file mode 100644 index 000000000..bfbe0a944 --- /dev/null +++ b/website/docs/api/HTTP/post-batch-predict.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Batch predictions completed successfully","content":{"application/json":{"schema":{"type":"object","required":["predictions","duration_ms"],"properties":{"duration_ms":{"type":"integer","minimum":0},"predictions":{"type":"array","items":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"}}},"title":"BatchPredictResponse"},"example":{"duration_ms":81,"predictions":[{"status":"Success","model_name":"drive_stats_a","model_version":"1.0","prediction":[0.45,0.5,0.55],"duration_ms":42},{"status":"Success","model_name":"drive_stats_b","model_version":"1.0","prediction":[0.43,0.51,0.53],"duration_ms":42}]}}}},"500":{"description":"Internal server error occurred during batch prediction","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing batch predictions"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-batch-predict.api.mdx b/website/docs/api/HTTP/post-batch-predict.api.mdx index 1792fe8ef..0480b4f64 100644 --- a/website/docs/api/HTTP/post-batch-predict.api.mdx +++ b/website/docs/api/HTTP/post-batch-predict.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/post-chat-completions.RequestSchema.json b/website/docs/api/HTTP/post-chat-completions.RequestSchema.json new file mode 100644 index 000000000..4f2845758 --- /dev/null +++ b/website/docs/api/HTTP/post-chat-completions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Create a chat completion request using a language model.","content":{"application/json":{"schema":{"type":"object","required":["messages","model"],"properties":{"audio":{"oneOf":[{"type":"null"},{"description":"Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](https://platform.openai.com/docs/guides/audio).","type":"object","required":["voice","format"],"properties":{"format":{"description":"Specifies the output audio format. Must be one of `wav`, `aac`, `mp3`, `flac`, `opus`, or `pcm16`.","type":"string","enum":["wav","aac","mp3","flac","opus","pcm16"],"title":"ChatCompletionAudioFormat"},"voice":{"description":"The voice the model uses to respond. Supported voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.","oneOf":[{"type":"string","enum":["alloy"]},{"type":"string","enum":["ash"]},{"type":"string","enum":["ballad"]},{"type":"string","enum":["coral"]},{"type":"string","enum":["echo"]},{"type":"string","enum":["fable"]},{"type":"string","enum":["nova"]},{"type":"string","enum":["onyx"]},{"type":"string","enum":["sage"]},{"type":"string","enum":["shimmer"]},{"type":"object","required":["other"],"properties":{"other":{"type":"string"}}}],"title":"ChatCompletionAudioVoice"}},"title":"ChatCompletionAudio"}]},"frequency_penalty":{"type":["number","null"],"format":"float","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim."},"function_call":{"oneOf":[{"type":"null"},{"description":"Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if functions are present.","oneOf":[{"type":"string","description":"The model does not call a function, and responds to the end-user.","enum":["none"]},{"type":"string","description":"The model can pick between an end-user or calling a function.","enum":["auto"]},{"type":"object","description":"Forces the model to call the specified function.","required":["Function"],"properties":{"Function":{"type":"object","description":"Forces the model to call the specified function.","required":["name"],"properties":{"name":{"type":"string"}}}}}],"title":"ChatCompletionFunctionCall"}]},"functions":{"type":["array","null"],"items":{"type":"object","required":["name","parameters"],"properties":{"description":{"type":["string","null"],"description":"A description of what the function does, used by the model to choose when and how to call the function."},"name":{"type":"string","description":"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."},"parameters":{"description":"The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list."}},"title":"ChatCompletionFunctions"},"description":"Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.","deprecated":true},"logit_bias":{"type":["object","null"],"description":"Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100.\nMathematically, the bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection;\nvalues like -100 or 100 should result in a ban or exclusive selection of the relevant token.","additionalProperties":{"type":"integer","format":"int32"},"propertyNames":{"type":"string"}},"logprobs":{"type":["boolean","null"],"description":"Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the `content` of `message`."},"max_completion_tokens":{"type":["integer","null"],"format":"int32","description":"An upper bound for the number of tokens that can be generated for a completion, including\nvisible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).","minimum":0},"max_tokens":{"type":["integer","null"],"format":"int32","description":"The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in\nthe chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API.\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o-series models](https://platform.openai.com/docs/guides/reasoning).","deprecated":true,"minimum":0},"messages":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["content"],"properties":{"content":{"description":"The contents of the developer message.","oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string"}},"title":"ChatCompletionRequestMessageContentPartText"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}}]}],"title":"ChatCompletionRequestDeveloperMessageContentPart"}}],"title":"ChatCompletionRequestDeveloperMessageContent"},"name":{"type":["string","null"],"description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."}},"title":"ChatCompletionRequestDeveloperMessage"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["developer"]}}}]},{"allOf":[{"type":"object","required":["content"],"properties":{"content":{"description":"The contents of the system message.","oneOf":[{"type":"string","description":"The text contents of the system message."},{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string"}},"title":"ChatCompletionRequestMessageContentPartText"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}}]}],"title":"ChatCompletionRequestSystemMessageContentPart"},"description":"An array of content parts with a defined type. For system messages, only type `text` is supported."}],"title":"ChatCompletionRequestSystemMessageContent"},"name":{"type":["string","null"],"description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."}},"title":"ChatCompletionRequestSystemMessage"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["system"]}}}]},{"allOf":[{"type":"object","required":["content"],"properties":{"content":{"description":"The contents of the user message.","oneOf":[{"type":"string","description":"The text contents of the message."},{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string"}},"title":"ChatCompletionRequestMessageContentPartText"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}}]},{"allOf":[{"type":"object","required":["image_url"],"properties":{"image_url":{"type":"object","required":["url"],"properties":{"detail":{"oneOf":[{"type":"null"},{"description":"Specifies the detail level of the image. Learn more in the [Vision guide](https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding).","type":"string","enum":["auto","low","high"],"title":"ImageDetail"}]},"url":{"type":"string","description":"Either a URL of the image or the base64 encoded image data."}},"title":"ImageUrl"}},"title":"ChatCompletionRequestMessageContentPartImage"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["image_url"]}}}]},{"allOf":[{"type":"object","description":"Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).","required":["input_audio"],"properties":{"input_audio":{"type":"object","required":["data","format"],"properties":{"data":{"type":"string","description":"Base64 encoded audio data."},"format":{"description":"The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".","type":"string","enum":["wav","mp3"],"title":"InputAudioFormat"}},"title":"InputAudio"}},"title":"ChatCompletionRequestMessageContentPartAudio"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["input_audio"]}}}]},{"allOf":[{"type":"object","required":["file"],"properties":{"file":{"type":"object","properties":{"file_data":{"type":["string","null"],"description":"The base64 encoded file data, used when passing the file to the model\nas a string."},"file_id":{"type":["string","null"],"description":"The ID of an uploaded file to use as input."},"filename":{"type":["string","null"],"description":"The name of the file, used when passing the file to the model as a\nstring."}},"title":"FileObject"}},"title":"ChatCompletionRequestMessageContentPartFile"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["file"]}}}]}],"title":"ChatCompletionRequestUserMessageContentPart"},"description":"An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text, image, or audio inputs."}],"title":"ChatCompletionRequestUserMessageContent"},"name":{"type":["string","null"],"description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."}},"title":"ChatCompletionRequestUserMessage"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["user"]}}}]},{"allOf":[{"type":"object","properties":{"audio":{"oneOf":[{"type":"null"},{"description":"Data about a previous audio response from the model.\n[Learn more](https://platform.openai.com/docs/guides/audio).","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a previous audio response from the model."}},"title":"ChatCompletionRequestAssistantMessageAudio"}]},"content":{"oneOf":[{"type":"null"},{"description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.","oneOf":[{"type":"string","description":"The text contents of the message."},{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string"}},"title":"ChatCompletionRequestMessageContentPartText"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}}]},{"allOf":[{"type":"object","required":["refusal"],"properties":{"refusal":{"type":"string","description":"The refusal message generated by the model."}},"title":"ChatCompletionRequestMessageContentPartRefusal"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["refusal"]}}}]}],"title":"ChatCompletionRequestAssistantMessageContentPart"},"description":"An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`."}],"title":"ChatCompletionRequestAssistantMessageContent"}]},"function_call":{"oneOf":[{"type":"null"},{"description":"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.","type":"object","required":["name","arguments"],"properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}},"title":"FunctionCall"}]},"name":{"type":["string","null"],"description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."},"refusal":{"type":["string","null"],"description":"The refusal message by the assistant."},"tool_calls":{"type":["array","null"],"items":{"oneOf":[{"allOf":[{"type":"object","required":["id","function"],"properties":{"function":{"description":"The function that the model called.","type":"object","required":["name","arguments"],"properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}},"title":"FunctionCall"},"id":{"type":"string","description":"The ID of the tool call."}},"title":"ChatCompletionMessageToolCall"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["function"]}}}]},{"allOf":[{"type":"object","required":["id","custom_tool"],"properties":{"custom_tool":{"description":"The custom tool that the model called.","type":"object","required":["name","input"],"properties":{"input":{"type":"string","description":"The input for the custom tool call generated by the model."},"name":{"type":"string","description":"The name of the custom tool to call."}},"title":"CustomTool"},"id":{"type":"string","description":"The ID of the tool call."}},"title":"ChatCompletionMessageCustomToolCall"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["custom"]}}}]}],"title":"ChatCompletionMessageToolCalls"}}},"title":"ChatCompletionRequestAssistantMessage"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["assistant"]}}}]},{"allOf":[{"type":"object","description":"Tool message","required":["content","tool_call_id"],"properties":{"content":{"description":"The contents of the tool message.","oneOf":[{"type":"string","description":"The text contents of the tool message."},{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string"}},"title":"ChatCompletionRequestMessageContentPartText"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}}]}],"title":"ChatCompletionRequestToolMessageContentPart"},"description":"An array of content parts with a defined type. For tool messages, only type `text` is supported."}],"title":"ChatCompletionRequestToolMessageContent"},"tool_call_id":{"type":"string"}},"title":"ChatCompletionRequestToolMessage"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["tool"]}}}]},{"allOf":[{"type":"object","required":["name"],"properties":{"content":{"type":["string","null"],"description":"The return value from the function call, to return to the model."},"name":{"type":"string","description":"The name of the function to call."}},"title":"ChatCompletionRequestFunctionMessage"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["function"]}}}]}],"title":"ChatCompletionRequestMessage"},"description":"A list of messages comprising the conversation so far. Depending on the\n[model](https://platform.openai.com/docs/models) you use, different message types (modalities)\nare supported, like [text](https://platform.openai.com/docs/guides/text-generation),\n[images](https://platform.openai.com/docs/guides/vision), and\n[audio](https://platform.openai.com/docs/guides/audio)."},"metadata":{"oneOf":[{"type":"null"},{"description":"Developer-defined tags and values used for filtering completions in the [dashboard](https://platform.openai.com/chat-completions).","type":"object","required":["supports_responses_api"],"properties":{"supports_responses_api":{"type":"boolean"}},"title":"Metadata"}]},"modalities":{"type":["array","null"],"items":{"type":"string","description":"Output types that you would like the model to generate for this request.\n\nMost models are capable of generating text, which is the default: `[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate\naudio](https://platform.openai.com/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `[\"text\", \"audio\"]`","enum":["text","audio"],"title":"ResponseModalities"},"description":"Output types that you would like the model to generate. Most models are capable of generating\ntext, which is the default:\n\n`[\"text\"]`\nThe `gpt-4o-audio-preview` model can also be used to\n[generate audio](https://platform.openai.com/docs/guides/audio). To request that this model\ngenerate both text and audio responses, you can use:\n\n`[\"text\", \"audio\"]`"},"model":{"type":"string","description":"Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the\n[model guide](https://platform.openai.com/docs/models)\nto browse and compare available models."},"n":{"type":["integer","null"],"format":"int32","description":"How many chat completion choices to generate for each input message. Note that you will be\ncharged based on the number of generated tokens across all of the choices. Keep `n` as `1` to\nminimize costs.","minimum":0},"parallel_tool_calls":{"type":["boolean","null"],"description":"Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)\nduring tool use."},"prediction":{"oneOf":[{"type":"null"},{"description":"Configuration for a [Predicted Output](https://platform.openai.com/docs/guides/predicted-outputs),\nwhich can greatly improve response times when large parts of the model\nresponse are known ahead of time. This is most common when you are\nregenerating a file with only minor changes to most of the content.","oneOf":[{"type":"object","description":"The type of the predicted content you want to provide. This type is\ncurrently always `content`.","required":["content","type"],"properties":{"content":{"description":"The type of the predicted content you want to provide. This type is\ncurrently always `content`.","oneOf":[{"type":"string","description":"The content used for a Predicted Output. This is often the text of a file you are regenerating with minor changes."},{"type":"array","items":{"type":"object","required":["text"],"properties":{"text":{"type":"string"}},"title":"ChatCompletionRequestMessageContentPartText"},"description":"An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text inputs."}],"title":"PredictionContentContent"},"type":{"type":"string","enum":["content"]}}}],"title":"PredictionContent"}]},"presence_penalty":{"type":["number","null"],"format":"float","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics."},"prompt_cache_key":{"type":["string","null"],"description":"Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces\nthe `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching)."},"reasoning_effort":{"oneOf":[{"type":"null"},{"description":"Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `minimal`, `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\nNote: The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.","type":"string","enum":["none","minimal","low","medium","high","xhigh"],"title":"ReasoningEffort"}]},"response_format":{"oneOf":[{"type":"null"},{"description":"An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.","oneOf":[{"type":"object","description":"The type of response format being defined: `text`","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","description":"The type of response format being defined: `json_object`","required":["type"],"properties":{"type":{"type":"string","enum":["json_object"]}}},{"type":"object","description":"The type of response format being defined: `json_schema`","required":["json_schema","type"],"properties":{"json_schema":{"type":"object","required":["name"],"properties":{"description":{"type":["string","null"],"description":"A description of what the response format is for, used by the model to determine how to respond in the format."},"name":{"type":"string","description":"The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."},"schema":{"description":"The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/)."},"strict":{"type":["boolean","null"],"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs)."}},"title":"ResponseFormatJsonSchema"},"type":{"type":"string","enum":["json_schema"]}}}],"title":"ResponseFormat"}]},"safety_identifier":{"type":["string","null"],"description":"A stable identifier used to help detect users of your application that may be violating OpenAI's\nusage policies.\n\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username\nor email address, in order to avoid sending us any identifying information. [Learn\nmore](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers)."},"seed":{"type":["integer","null"],"format":"int64","description":"This feature is in Beta.\n\nIf specified, our system will make a best effort to sample deterministically, such that\nrepeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response\nparameter to monitor changes in the backend.","deprecated":true},"service_tier":{"oneOf":[{"type":"null"},{"description":"Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\n\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.","type":"string","enum":["auto","default","flex","scale","priority"],"title":"ServiceTier"}]},"stop":{"oneOf":[{"type":"null"},{"description":"Not supported with latest reasoning models `o3` and `o4-mini`.\n\nUp to 4 sequences where the API will stop generating further tokens. The\nreturned text will not contain the stop sequence.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"StopConfiguration"}]},"store":{"type":["boolean","null"],"description":"Whether or not to store the output of this chat completion request for\nuse in our [model distillation](https://platform.openai.com/docs/guides/distillation) or\n[evals](https://platform.openai.com/docs/guides/evals) products.\n\nSupports text and image inputs. Note: image inputs over 8MB will be dropped."},"stream":{"type":["boolean","null"],"description":"If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)\nfor more information, along with the [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)\nguide for more information on how to handle the streaming events."},"stream_options":{"oneOf":[{"type":"null"},{"type":"object","description":"Options for streaming response. Only set this when you set `stream: true`.","properties":{"include_obfuscation":{"type":["boolean","null"],"description":"When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events to\nnormalize payload sizes as a mitigation to certain side-channel attacks.\nThese obfuscation fields are included by default, but add a small amount\nof overhead to the data stream. You can set `include_obfuscation` to\nfalse to optimize for bandwidth if you trust the network links between\nyour application and the OpenAI API."},"include_usage":{"type":["boolean","null"],"description":"If set, an additional chunk will be streamed before the `data: [DONE]`\nmessage. The `usage` field on this chunk shows the token usage statistics\nfor the entire request, and the `choices` field will always be an empty\narray.\n\nAll other chunks will also include a `usage` field, but with a null\nvalue. **NOTE:** If the stream is interrupted, you may not receive the\nfinal usage chunk which contains the total token usage for the request."}},"title":"ChatCompletionStreamOptions"}]},"temperature":{"type":["number","null"],"format":"float","description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\nwhile lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both."},"tool_choice":{"oneOf":[{"type":"null"},{"description":"Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces\nthe model to call that tool.\n`none` is the default when no tools are present. `auto` is the default if tools are present.","oneOf":[{"allOf":[{"type":"object","required":["allowed_tools"],"properties":{"allowed_tools":{"type":"array","items":{"type":"object","required":["mode","tools"],"properties":{"mode":{"description":"Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.","type":"string","enum":["auto","required"],"title":"ToolChoiceAllowedMode"},"tools":{"type":"array","items":{},"description":"A list of tool definitions that the model should be allowed to call.\n\nFor the Chat Completions API, the list of tool definitions might look like:\n```json\n[\n { \"type\": \"function\", \"function\": { \"name\": \"get_weather\" } },\n { \"type\": \"function\", \"function\": { \"name\": \"get_time\" } }\n]\n```"}},"title":"ChatCompletionAllowedTools"}}},"title":"ChatCompletionAllowedToolsChoice"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["allowed_tools"]}}}]},{"allOf":[{"type":"object","description":"Specifies a tool the model should use. Use to force the model to call a specific function.","required":["function"],"properties":{"function":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the function to call."}},"title":"FunctionName"}},"title":"ChatCompletionNamedToolChoice"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["function"]}}}]},{"allOf":[{"type":"object","required":["custom"],"properties":{"custom":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the custom tool to call."}},"title":"CustomName"}},"title":"ChatCompletionNamedToolChoiceCustom"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["custom"]}}}]},{"allOf":[{"type":"string","enum":["none","auto","required"],"title":"ToolChoiceOptions"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["mode"]}}}]}],"title":"ChatCompletionToolChoiceOption"}]},"tools":{"type":["array","null"],"items":{"oneOf":[{"allOf":[{"description":"A function tool that can be used to generate a response.","type":"object","required":["function"],"properties":{"function":{"type":"object","required":["name"],"properties":{"description":{"type":["string","null"],"description":"A description of what the function does, used by the model to choose when and how to call the function."},"name":{"type":"string","description":"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."},"parameters":{"description":"The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list."},"strict":{"type":["boolean","null"],"description":"Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling)."}},"title":"FunctionObject"}},"title":"ChatCompletionTool"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["function"]}}}],"description":"A function tool that can be used to generate a response."},{"allOf":[{"description":"A custom tool that processes input using a specified format.","type":"object","required":["custom"],"properties":{"custom":{"type":"object","required":["name","format"],"properties":{"description":{"type":["string","null"],"description":"Optional description of the custom tool, used to provide more context."},"format":{"description":"The input format for the custom tool. Default is unconstrained text.","oneOf":[{"type":"object","description":"Unconstrained free-form text.","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","description":"A grammar defined by the user.","required":["grammar","type"],"properties":{"grammar":{"type":"object","required":["definition","syntax"],"properties":{"definition":{"type":"string","description":"The grammar definition."},"syntax":{"description":"The syntax of the grammar definition. One of `lark` or `regex`.","type":"string","enum":["lark","regex"],"title":"GrammarSyntax"}},"title":"CustomGrammarFormatParam"},"type":{"type":"string","enum":["grammar"]}}}],"title":"CustomToolPropertiesFormat"},"name":{"type":"string","description":"The name of the custom tool, used to identify it in tool calls."}},"title":"CustomToolProperties"}},"title":"CustomToolChatCompletions"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["custom"]}}}],"description":"A custom tool that processes input using a specified format."}],"title":"ChatCompletionTools"},"description":"A list of tools the model may call. You can provide either\n[custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) or\n[function tools](https://platform.openai.com/docs/guides/function-calling)."},"top_logprobs":{"type":["integer","null"],"format":"int32","description":"An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n`logprobs` must be set to `true` if this parameter is used.","minimum":0},"top_p":{"type":["number","null"],"format":"float","description":"An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability mass.\nSo 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\n We generally recommend altering this or `temperature` but not both."},"user":{"type":["string","null"],"description":"This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key`\ninstead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and\nprevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).","deprecated":true},"verbosity":{"oneOf":[{"type":"null"},{"description":"Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`.","type":"string","enum":["low","medium","high"],"title":"Verbosity"}]},"web_search_options":{"oneOf":[{"type":"null"},{"description":"This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).","type":"object","properties":{"search_context_size":{"oneOf":[{"type":"null"},{"description":"High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.","type":"string","enum":["low","medium","high"],"title":"WebSearchContextSize"}]},"user_location":{"oneOf":[{"type":"null"},{"description":"Approximate location parameters for the search.","type":"object","required":["type","approximate"],"properties":{"approximate":{"type":"object","description":"Approximate location parameters for the search.","properties":{"city":{"type":["string","null"],"description":"Free text input for the city of the user, e.g. `San Francisco`."},"country":{"type":["string","null"],"description":"The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`."},"region":{"type":["string","null"],"description":"Free text input for the region of the user, e.g. `California`."},"timezone":{"type":["string","null"],"description":"The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`."}},"title":"WebSearchLocation"},"type":{"type":"string","enum":["approximate"],"title":"WebSearchUserLocationType"}},"title":"WebSearchUserLocation"}]}},"title":"WebSearchOptions"}]}},"title":"CreateChatCompletionRequest"},"example":{"model":"gpt-4o","messages":[{"role":"developer","content":"You are a helpful assistant."},{"role":"user","content":"Hello!"}],"stream":false}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-chat-completions.StatusCodes.json b/website/docs/api/HTTP/post-chat-completions.StatusCodes.json new file mode 100644 index 000000000..b24e948d9 --- /dev/null +++ b/website/docs/api/HTTP/post-chat-completions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Chat completion generated successfully","content":{"application/json":{"schema":{"type":"object","description":"Represents a chat completion response returned by model, based on the provided input.","required":["id","choices","created","model","object"],"properties":{"choices":{"type":"array","items":{"type":"object","required":["index","message"],"properties":{"finish_reason":{"oneOf":[{"type":"null"},{"description":"The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.","type":"string","enum":["stop","length","tool_calls","content_filter","function_call"],"title":"FinishReason"}]},"index":{"type":"integer","format":"int32","description":"The index of the choice in the list of choices.","minimum":0},"logprobs":{"oneOf":[{"type":"null"},{"description":"Log probability information for the choice.","type":"object","properties":{"content":{"type":["array","null"],"items":{"type":"object","required":["token","logprob","top_logprobs"],"properties":{"bytes":{"type":["array","null"],"items":{"type":"integer","format":"int32","minimum":0},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"logprob":{"type":"number","format":"float","description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely."},"token":{"type":"string","description":"The token."},"top_logprobs":{"type":"array","items":{"type":"object","required":["token","logprob"],"properties":{"bytes":{"type":["array","null"],"items":{"type":"integer","format":"int32","minimum":0},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"logprob":{"type":"number","format":"float","description":"The log probability of this token."},"token":{"type":"string","description":"The token."}},"title":"TopLogprobs"},"description":"List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned."}},"title":"ChatCompletionTokenLogprob"},"description":"A list of message content tokens with log probability information."},"refusal":{"type":["array","null"],"items":{"type":"object","required":["token","logprob","top_logprobs"],"properties":{"bytes":{"type":["array","null"],"items":{"type":"integer","format":"int32","minimum":0},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"logprob":{"type":"number","format":"float","description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely."},"token":{"type":"string","description":"The token."},"top_logprobs":{"type":"array","items":{"type":"object","required":["token","logprob"],"properties":{"bytes":{"type":["array","null"],"items":{"type":"integer","format":"int32","minimum":0},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"logprob":{"type":"number","format":"float","description":"The log probability of this token."},"token":{"type":"string","description":"The token."}},"title":"TopLogprobs"},"description":"List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned."}},"title":"ChatCompletionTokenLogprob"}}},"title":"ChatChoiceLogprobs"}]},"message":{"type":"object","description":"A chat completion message generated by the model.","required":["role"],"properties":{"annotations":{"type":["array","null"],"items":{"oneOf":[{"type":"object","required":["url_citation","type"],"properties":{"type":{"type":"string","enum":["url_citation"]},"url_citation":{"type":"object","required":["end_index","start_index","title","url"],"properties":{"end_index":{"type":"integer","format":"int32","description":"The index of the last character of the URL citation in the message.","minimum":0},"start_index":{"type":"integer","format":"int32","description":"The index of the first character of the URL citation in the message.","minimum":0},"title":{"type":"string","description":"The title of the web resource."},"url":{"type":"string","description":"The URL of the web resource."}},"title":"UrlCitation"}}}],"title":"ChatCompletionResponseMessageAnnotation"}},"audio":{"oneOf":[{"type":"null"},{"description":"If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio).","type":"object","required":["id","expires_at","data","transcript"],"properties":{"data":{"type":"string","description":"Base64 encoded audio bytes generated by the model, in the format specified in the request."},"expires_at":{"type":"integer","format":"int64","description":"The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations.","minimum":0},"id":{"type":"string","description":"Unique identifier for this audio response."},"transcript":{"type":"string","description":"Transcript of the audio generated by the model."}},"title":"ChatCompletionResponseMessageAudio"}]},"content":{"type":["string","null"],"description":"The contents of the message."},"function_call":{"oneOf":[{"type":"null"},{"description":"Deprecated and replaced by `tool_calls`.\nThe name and arguments of a function that should be called, as generated by the model.","type":"object","required":["name","arguments"],"properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}},"title":"FunctionCall"}]},"refusal":{"type":["string","null"],"description":"The refusal message generated by the model."},"role":{"description":"The role of the author of this message.","type":"string","enum":["system","user","assistant","tool","function"],"title":"Role"},"tool_calls":{"type":["array","null"],"items":{"oneOf":[{"allOf":[{"type":"object","required":["id","function"],"properties":{"function":{"description":"The function that the model called.","type":"object","required":["name","arguments"],"properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}},"title":"FunctionCall"},"id":{"type":"string","description":"The ID of the tool call."}},"title":"ChatCompletionMessageToolCall"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["function"]}}}]},{"allOf":[{"type":"object","required":["id","custom_tool"],"properties":{"custom_tool":{"description":"The custom tool that the model called.","type":"object","required":["name","input"],"properties":{"input":{"type":"string","description":"The input for the custom tool call generated by the model."},"name":{"type":"string","description":"The name of the custom tool to call."}},"title":"CustomTool"},"id":{"type":"string","description":"The ID of the tool call."}},"title":"ChatCompletionMessageCustomToolCall"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["custom"]}}}]}],"title":"ChatCompletionMessageToolCalls"},"description":"The tool calls generated by the model, such as function calls."}},"title":"ChatCompletionResponseMessage"}},"title":"ChatChoice"},"description":"A list of chat completion choices. Can be more than one if `n` is greater than 1."},"created":{"type":"integer","format":"int32","description":"The Unix timestamp (in seconds) of when the chat completion was created.","minimum":0},"id":{"type":"string","description":"A unique identifier for the chat completion."},"model":{"type":"string","description":"The model used for the chat completion."},"object":{"type":"string","description":"The object type, which is always `chat.completion`."},"service_tier":{"oneOf":[{"type":"null"},{"description":"The service tier used for processing the request. This field is only included if the `service_tier` parameter is specified in the request.","type":"string","enum":["auto","default","flex","scale","priority"],"title":"ServiceTier"}]},"system_fingerprint":{"type":["string","null"],"description":"This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.","deprecated":true},"usage":{"oneOf":[{"type":"null"},{"type":"object","description":"Usage statistics for the completion request.","required":["prompt_tokens","completion_tokens","total_tokens"],"properties":{"completion_tokens":{"type":"integer","format":"int32","description":"Number of tokens in the generated completion.","minimum":0},"completion_tokens_details":{"oneOf":[{"type":"null"},{"description":"Breakdown of tokens used in a completion.","type":"object","properties":{"accepted_prediction_tokens":{"type":["integer","null"],"format":"int32","minimum":0},"audio_tokens":{"type":["integer","null"],"format":"int32","description":"Audio input tokens generated by the model.","minimum":0},"reasoning_tokens":{"type":["integer","null"],"format":"int32","description":"Tokens generated by the model for reasoning.","minimum":0},"rejected_prediction_tokens":{"type":["integer","null"],"format":"int32","description":" When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context\nwindow limits.","minimum":0}},"title":"CompletionTokensDetails"}]},"prompt_tokens":{"type":"integer","format":"int32","description":"Number of tokens in the prompt.","minimum":0},"prompt_tokens_details":{"oneOf":[{"type":"null"},{"description":"Breakdown of tokens used in the prompt.","type":"object","properties":{"audio_tokens":{"type":["integer","null"],"format":"int32","description":"Audio input tokens present in the prompt.","minimum":0},"cached_tokens":{"type":["integer","null"],"format":"int32","description":"Cached tokens present in the prompt.","minimum":0}},"title":"PromptTokensDetails"}]},"total_tokens":{"type":"integer","format":"int32","description":"Total number of tokens used in the request (prompt + completion).","minimum":0}},"title":"CompletionUsage"}]}},"title":"CreateChatCompletionResponse"},"example":{"id":"chatcmpl-123","object":"chat.completion","created":1677652288,"model":"gpt-4o-mini","system_fingerprint":"fp_44709d6fcb","choices":[{"index":0,"message":{"role":"assistant","content":"\n\nHello there, how may I assist you today?"},"logprobs":null,"finish_reason":"stop"}],"usage":{"prompt_tokens":9,"completion_tokens":12,"total_tokens":21,"completion_tokens_details":{"reasoning_tokens":0,"accepted_prediction_tokens":0,"rejected_prediction_tokens":0}}}}}},"404":{"description":"The specified model was not found"},"500":{"description":"An internal server error occurred while processing the chat completion","content":{"application/json":{"schema":{},"example":{"error":"An internal server error occurred while processing the chat completion."}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-chat-completions.api.mdx b/website/docs/api/HTTP/post-chat-completions.api.mdx index 19795de80..3bed4a906 100644 --- a/website/docs/api/HTTP/post-chat-completions.api.mdx +++ b/website/docs/api/HTTP/post-chat-completions.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/post-dataset-refresh.ParamsDetails.json b/website/docs/api/HTTP/post-dataset-refresh.ParamsDetails.json new file mode 100644 index 000000000..6b3594153 --- /dev/null +++ b/website/docs/api/HTTP/post-dataset-refresh.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"path","description":"The name of the dataset to refresh.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-dataset-refresh.RequestSchema.json b/website/docs/api/HTTP/post-dataset-refresh.RequestSchema.json new file mode 100644 index 000000000..d98944f46 --- /dev/null +++ b/website/docs/api/HTTP/post-dataset-refresh.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"On-demand refresh request for a specific dataset.","content":{"application/json":{"schema":{"type":"object","description":"[`RefreshOverrides`] specifies the configurable options for a individual run of a refresh task.","properties":{"refresh_jitter_max":{"type":["string","null"],"description":"The maximum amount of jitter to add to the refresh. Defaults to the `refresh_jitter_max` specified in the spicepod, or 10% of the `refresh_check_interval`.","example":"10s"},"refresh_mode":{"oneOf":[{"type":"null"},{"description":"The refresh mode to use for this refresh. Defaults to the `refresh_mode` specified in the spicepod, or `full`.","type":"string","enum":["disabled","full","append","changes","caching"],"title":"RefreshMode"}]},"refresh_sql":{"type":["string","null"],"description":"The SQL statement used for this refresh. Defaults to the `refresh_sql` specified in the spicepod, if any."}},"title":"RefreshOverrides"},"example":{"refresh_sql":"SELECT * FROM taxi_trips WHERE tip_amount > 10.0","refresh_mode":"full","refresh_jitter_max":"10s"}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-dataset-refresh.StatusCodes.json b/website/docs/api/HTTP/post-dataset-refresh.StatusCodes.json new file mode 100644 index 000000000..cda723968 --- /dev/null +++ b/website/docs/api/HTTP/post-dataset-refresh.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Dataset refresh triggered successfully","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset refresh triggered for taxi_trips."}}}},"400":{"description":"Acceleration not enabled for the dataset","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset taxi_trips does not have acceleration enabled"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset taxi_trips not found"}}}},"500":{"description":"Internal server error occurred while processing refresh","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Unexpected internal error occurred while processing refresh"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-dataset-refresh.api.mdx b/website/docs/api/HTTP/post-dataset-refresh.api.mdx index 86709dffc..dc25eca3f 100644 --- a/website/docs/api/HTTP/post-dataset-refresh.api.mdx +++ b/website/docs/api/HTTP/post-dataset-refresh.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request 10.0","refresh_mode":"full","refresh_jitter_max":"10s"}}},"required":true}} + {...require("./post-dataset-refresh.RequestSchema.json")} > diff --git a/website/docs/api/HTTP/post-embeddings.RequestSchema.json b/website/docs/api/HTTP/post-embeddings.RequestSchema.json new file mode 100644 index 000000000..c776af1f5 --- /dev/null +++ b/website/docs/api/HTTP/post-embeddings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Embedding creation request parameters","content":{"application/json":{"schema":{"type":"object","required":["model","input"],"properties":{"dimensions":{"type":["integer","null"],"format":"int32","description":"The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.","minimum":0},"encoding_format":{"oneOf":[{"type":"null"},{"description":"The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).","type":"string","enum":["float","base64"],"title":"EncodingFormat"}]},"input":{"description":"Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single\nrequest, pass an array of strings or array of token arrays. The input must not exceed the max\ninput tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and\nany array must be 2048 dimensions or less. [Example Python\ncode](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\nIn addition to the per-input token limit, all embedding models enforce a maximum of 300,000\ntokens summed across all inputs in a single request.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer","format":"int32","minimum":0}},{"type":"array","items":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}}}],"title":"EmbeddingInput"},"model":{"type":"string","description":"ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list)\nAPI to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models)\nfor descriptions of them."},"user":{"type":["string","null"],"description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.\n[Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids)."}},"title":"CreateEmbeddingRequest"},"example":{"input":"The food was delicious and the waiter...","model":"text-embedding-ada-002","encoding_format":"float"}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-embeddings.StatusCodes.json b/website/docs/api/HTTP/post-embeddings.StatusCodes.json new file mode 100644 index 000000000..47bb9be75 --- /dev/null +++ b/website/docs/api/HTTP/post-embeddings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Embedding created successfully","content":{"application/json":{"schema":{"type":"object","required":["object","model","data","usage"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents an embedding vector returned by embedding endpoint.","required":["index","object","embedding"],"properties":{"embedding":{"description":"The embedding vector, which is a list of floats. The length of vector\ndepends on the model as listed in the [embedding guide](https://platform.openai.com/docs/guides/embeddings).","oneOf":[{"type":"array","items":{"type":"number","format":"float"}},{"type":"string"}],"title":"EmbeddingVector"},"index":{"type":"integer","format":"int32","description":"The index of the embedding in the list of embeddings.","minimum":0},"object":{"type":"string","description":"The object type, which is always \"embedding\"."}},"title":"Embedding"},"description":"The list of embeddings generated by the model."},"model":{"type":"string","description":"The name of the model used to generate the embedding."},"object":{"type":"string"},"usage":{"description":"The usage information for the request.","type":"object","required":["prompt_tokens","total_tokens"],"properties":{"prompt_tokens":{"type":"integer","format":"int32","description":"The number of tokens used by the prompt.","minimum":0},"total_tokens":{"type":"integer","format":"int32","description":"The total number of tokens used by the request.","minimum":0}},"title":"EmbeddingUsage"}},"title":"CreateEmbeddingResponse"},"example":{"object":"list","data":[{"object":"embedding","embedding":[0.0023064255,-0.009327292,-0.0028842222],"index":0}],"model":"text-embedding-ada-002","usage":{"prompt_tokens":8,"total_tokens":8}}}}},"404":{"description":"Model not found","content":{"application/json":{"schema":{"type":"string"},"example":{"error":"model not found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"string"},"example":{"error":"Unexpected internal server error occurred"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-embeddings.api.mdx b/website/docs/api/HTTP/post-embeddings.api.mdx index e42a202c9..9c4a4a6a4 100644 --- a/website/docs/api/HTTP/post-embeddings.api.mdx +++ b/website/docs/api/HTTP/post-embeddings.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/post-eval.ParamsDetails.json b/website/docs/api/HTTP/post-eval.ParamsDetails.json new file mode 100644 index 000000000..4f65e1f9f --- /dev/null +++ b/website/docs/api/HTTP/post-eval.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"path","description":"Name of the evaluation to run","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-eval.RequestSchema.json b/website/docs/api/HTTP/post-eval.RequestSchema.json new file mode 100644 index 000000000..60880061f --- /dev/null +++ b/website/docs/api/HTTP/post-eval.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Parameters to run the evaluation","content":{"application/json":{"schema":{"type":"object","description":"Input parameters to start an evaluation run for a given model.","required":["model"],"properties":{"model":{"type":"string"}},"title":"RunEval"},"example":{"model":"example_model"}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-eval.StatusCodes.json b/website/docs/api/HTTP/post-eval.StatusCodes.json new file mode 100644 index 000000000..bda43f846 --- /dev/null +++ b/website/docs/api/HTTP/post-eval.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Evaluation run successfully","content":{"application/json":{"schema":{"type":"object","description":"Represents the response for an evaluation run","required":["primary_key","time_column","dataset","model","status","scorers","metrics"],"properties":{"dataset":{"type":"string","description":"The name of the dataset used for the evaluation"},"error_message":{"type":["string","null"],"description":"The error message if the evaluation failed, otherwise `None`"},"metrics":{"type":"object","description":"A map of metric names to their corresponding values","additionalProperties":{"type":"number","format":"double"},"propertyNames":{"type":"string"}},"model":{"type":"string","description":"The model used for the evaluation"},"primary_key":{"type":"string","description":"Unique identifier for the evaluation run"},"scorers":{"type":"array","items":{"type":"string"},"description":"List of scorers used in the evaluation"},"status":{"type":"string","description":"The status of the evaluation (e.g., \"completed\", \"failed\", etc.)"},"time_column":{"type":"string","description":"Timestamp indicating when the evaluation was created or run"}},"title":"EvalRunResponse"},"example":{"primary_key":"eval_12345","time_column":"2024-12-19T12:34:56Z","dataset":"my_dataset","model":"example_model","status":"completed","error_message":null,"scorers":["scorer1","scorer2"],"metrics":{"scorer1/accuracy":0.95,"scorer2/accuracy":0.93}}},"text/csv":{"example":"primary_key,time_column,dataset,model,status,error_message,scorers,metrics\neval_12345,2024-12-19T12:34:56Z,my_dataset,example_model,completed,,\"[\"\"scorer1\"\", \"\"scorer2\"\"]\",\"{\"\"scorer1/accuracy\"\":0.95, \"\"scorer2/accuracy\"\":0.93}\""},"text/plain":{"example":"+-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+\n | primary_key | time_column | dataset | model | status | error_message | scorers | metrics |\n +-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+\n | eval_12345 | 2024-12-19T12:34:56Z| my_dataset| example_model | completed | | scorer1, scorer2 | {\"accuracy\": 0.95, \"precision\": 0.93} |\n +-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-eval.api.mdx b/website/docs/api/HTTP/post-eval.api.mdx new file mode 100644 index 000000000..b73a57ac1 --- /dev/null +++ b/website/docs/api/HTTP/post-eval.api.mdx @@ -0,0 +1,70 @@ +--- +id: post-eval +title: "Run Eval" +description: "Evaluate a model against a eval spice specification" +sidebar_label: "Run Eval" +hide_title: true +hide_table_of_contents: true +api: eJzVV0uP2zYQ/ivEnBqUfm5SNLqlwR4CBGmw3VxqG14uNbaYSqRCUt4Ysv57MaJkSba6WxS9xBdTw+E8vhkOZ0rwYu8gWsHtQaSF8MpoBxsOMTppVU7fELWbyATLTIwpE3uhtPNMMDyIlLlcSWQuR6l2StZSgIPJ0dbrDzFEkBvnt8QNHHJhRYYeLakuQYsMIQp/HBRpzIVP4NKMTyJDZnbMJ1jrDfYyb5gtSKHFb4WyGEPkbYEcnEwwExCV4I85aXDeKr2HqtoEZnT+NxMfiWOo6fPZwEb6hU7gII32qD2dFXmeNm7PvjoSUF7rNo9fUfornz7ovPAsH+hzXljPhO47STbsjGWC7dUBdYjDdOD0CmoihS+3BL5X6MiCQB6BgYNXPiXSXaEpyFBxwO8iy4l4PtiStuG7ooNDrGuCy412QeNyPr8G9XbojSukROd2RZoe/z887zC36FB7V4estSpgd4noBXy5VZmwx+1fSAZ5leFWmrTIiC8WXjgkfQEEDs4LXzhaSGMplTlk6K2S7joC7emrGFyaf58g0700bw6ywmFc+3CRhxQva43dZuic2GOnYdWp0EWaXl9qUlWfZc1Zpq6u1k6oFGPOjE/QPimH7OGT0fhAeltnXwzJO5aJnBwKJ2r/6jz3CSrLpLEhSrHSe0a6kbAUcaxIgEg/D6BsdOkie0QLHHbGZsJDBLEpHlMkyxrsj1Qv3Hje/8OVGMMoVLxnAtBPmxclftHqW4FMxai92im0I0Lr1Ky6xOqECmsF5abymI15dqnto3KekG8kBS/UVTWrztn8rxAJvCOV+Cec7qecrUEaqhce4zXQZ0gjWqOX01dQDW/Xy0pVhs6LLGdKx3Vl0Hv2lOClI+xJOCYtCo8xMzbg2KtyVIHuCn3XFIWLajeII5DU7WJ58/rNRS2IYDlfvp4slpPF2/vFMrp5Hb355c9eiYggO24v68VlEe0Q78CCq8tMN7eXB6tmuThXnSXd695NbPZnQsrCCnmEaD59++bMPaTf1JXc43c/k+5Ax89o9MHgPe954xevveDBBz6wmjfm8saste6g5GPQ8Q4uPgCJn5HhfA2rNaxb/2hJidUSlrTcrIGvoeyxnd0lWkCif+hq+6ZaA7SQ5KlQegjKz5P+b/g1Rr3keG5vTNy4hhG+tWa934n1osdOrBe/Hk/7tNA61Lhur7nh9XoQXCLUv7aiBJ4m1Oz532lo5g+DZpe/9DWWwifW5fCJDZKYndg5jVvw+sKbVOXNYslOrFxDl5kRa/M2tyiVU0Y3xJvqh0GUesbQMiSmHQbqOcAnEMHssJgRxm5WUm9QUXVDe2jHg8JS+Uy8z6PZLDVSpIlxPvp1/nZ+9VJ8pG0W4wFTk2eoPQuSpuy90Tu1LyyyJ+UT9jCZkMSHKdAw4FAWVvljrU/kKrwBqw3tUQd61w0Lt9ftcff6Kr0z9XPWPDi20HT5xl9RGppi1rGkSiK9StF5InqXC5ngZDklR7uWYbhTcSCoguDFdLGYzieFdl603ZBxPhO6J/au0Ow2TGIDs8quCf+PI1/zjPfqZ8VD/Mom2Cs40OtVhxs4RLVJGw4UUtoty0fh8ItNq4rI3wq0dSQ4HIRVtU8Uo1g5WscQ7UTq8BlHfrprOvxX7KX5cdT6tvPS1HfV3SlEABxCl1CbX20qDgmKmEKzKput98GEyT0J6I5eDTcVb0+8kxJz/yzvpneJPv/+xz1weGwmWAoTpZx4orFGPAUzTR5m+qgMtBJSofdF3V1AkEm/vwF9wSKR +sidebar_class_name: "post api-method" +info_path: docs/api/HTTP/runtime +custom_edit_url: null +proxy: http://localhost:8090 +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Evaluate a model against a eval spice specification + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/HTTP/post-nsql.ParamsDetails.json b/website/docs/api/HTTP/post-nsql.ParamsDetails.json new file mode 100644 index 000000000..82fe3a9eb --- /dev/null +++ b/website/docs/api/HTTP/post-nsql.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"Accept","in":"header","description":"The format of the response, one of 'application/json' (default), 'application/vnd.spiceai.nsql.v1+json', 'application/sql', 'text/csv' or 'text/plain'. 'application/sql' will only return the SQL query generated by the model.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-nsql.RequestSchema.json b/website/docs/api/HTTP/post-nsql.RequestSchema.json new file mode 100644 index 000000000..e7fb1d334 --- /dev/null +++ b/website/docs/api/HTTP/post-nsql.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Request body to generate an NSQL query","content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"Names of datasets to sample from when constructing model context; this is a sampling hint and does not restrict which tables queries can target. If omitted, all datasets are used."},"model":{"type":"string","description":"The name of the model to use for SQL generation. If omitted, Spice defaults to the only compatible LLM model configured in the Spicepod."},"query":{"type":"string","description":"The natural language query to be converted into SQL"},"sample_data_enabled":{"type":"boolean","description":"Whether sample data is included in the context for SQL generation. Default: false"},"stream":{"type":"boolean","description":"If true, streams the response instead of waiting for completion"},"prompt_cache_key":{"type":["string","null"],"description":"Stable prompt-cache key forwarded to the configured NSQL model for provider-specific cache handling."}},"title":"Request"},"example":{"query":"Get the top 5 customers by total sales","stream":false,"sample_data_enabled":false,"datasets":["sales_data"],"prompt_cache_key":"sales-dashboard"}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-nsql.StatusCodes.json b/website/docs/api/HTTP/post-nsql.StatusCodes.json new file mode 100644 index 000000000..83994e1b6 --- /dev/null +++ b/website/docs/api/HTTP/post-nsql.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"SQL query executed successfully","content":{"application/json":{"schema":{"type":"array","items":{}},"example":[{"customer_id":"12345","total_sales":150000},{"customer_id":"67890","total_sales":125000}]},"application/sql":{"schema":{"type":"string"},"example":"\n SELECT customer_id, SUM(total_sales)\n FROM sales_data\n GROUP BY customer_id\n ORDER BY SUM(total_sales) DESC\n LIMIT 5\n "},"application/vnd.spiceai.nsql.v1+json":{"schema":{},"example":{"row_count":2,"schema":{"fields":[{"name":"customer_id","data_type":"String","nullable":false,"dict_id":0,"dict_is_ordered":false},{"name":"total_sales","data_type":"Int64","nullable":false,"dict_id":0,"dict_is_ordered":false}]},"data":[{"customer_id":"12345","total_sales":150000},{"customer_id":"67890","total_sales":125000}],"sql":"SELECT customer_id, SUM(total_sales) AS total_sales\nFROM sales_data\nGROUP BY customer_id\nORDER BY total_sales DESC\nLIMIT 5"}},"text/event-stream":{"schema":{"type":"string"},"example":"data: {\"row_count\": 2, \"schema\": {...}, \"data\": [...], \"sql\": \"SELECT ...\"}\n\n"}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"string"},"example":"Model nsql not found"}}},"500":{"description":"Internal server error","content":{"text/plain":{"schema":{"type":"string"},"example":"No query produced from NSQL model"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-nsql.api.mdx b/website/docs/api/HTTP/post-nsql.api.mdx index d139ad3de..6b37b9187 100644 --- a/website/docs/api/HTTP/post-nsql.api.mdx +++ b/website/docs/api/HTTP/post-nsql.api.mdx @@ -5,7 +5,7 @@ description: "Generate and optionally execute a natural-language text-to-SQL (NS sidebar_label: "Text-to-SQL (NSQL)" hide_title: true hide_table_of_contents: true -api: eJztV21v2zYQ/iuH+9IWkxUna7pO+9SXrAiQvsUpisE2HEY6W2xpUiEpu4bh/z4cJVuS7RZZgWFf5k8Webx7ePfcC9foxcxhMsTBxyscR5iRS60svDQaE3xDmqzwBEJnYMKqUGoF9I3SkpdBC19aoXpK6FkpZgSevvmeN73Bxyt4/G7w8eoJ3JdkV/FIj/RNLh2QzgojtYdZrd2BABYPclA6qWeNZthprrZrnccBOZA+ZjPUUijdzlIGdyvwOYErKJVTSRnMTUYqqKt1ZCCnQeb2RZpS4W8hJ5GRZT3aeHDkwRu4FUWhZCoYwom7V7fxSH/OScOt85bE/JblvS0pCsosucJoR7xaCVAGwsGA7IJsb0Daw8WCtHfweDC4eBJjhKZg0NLoywwTLIzzE+3uFUZYCCvm5Mly6NaoxZwwwQovRig5dhVq3A8p+2Zq7Fx4MNMOtAiMJl581L7aF2f0I3ic0VSUyj+JursLncWukCkJGTO2eHH6SzixJ+fuFS8xOU5St3gExtZfhRJSP4oPxWEplQKj1Qos+dLqALYJ60FMQyTZb5buS2kpwyT4H12a01xgska/KthRzlupZ7jZjCthcv6lyVYs0XXWdbUJdyZbcdBnTT7Aux0UjDA12pP2rGHfebx2gMDcfaHUd7AOsVI2jrCwHHovyQVIwgtH3jXHhyisFWxXl0rxCelp7o7ccD/678ScHMd4q5Rv5cS8UARTa+awZAqnRjtvy9RzJlYJEi74zf8BnlNYcsqGYyyRczJzBmWGqhyxxABSD8tcpjl4cafIBWdJcpAKDV7YGfkYLqdg5tJ7yiIQSjW4hCUoHWUxXyJgOLzeMW5zLmyZXUH3hhUx6QN76hhKo2N4XbE6gRHqezVCtlVF4YG2jpYob+CO2GMLsqGeaG/YNGuvfD3ha05Is1+ylq07YxQJfWDsc04+J7uNFJ/mGEidqjILFsJ96yD9+KqcEwFJqEIPMH45retYdcLt1TPtPImMXb4UMjCGzaeGkQYNm02EXnpFTUKxffoWLsMAapfjGy6tOYE3BZxDWjpv5mRdSHDjhQInFDnc8YGDhs1NpkI5+o6Lq0rQpNIQg64gheMNY+yWjbBQ3TEk1lm/f1gfmmq0ax6uTFNybloq9TOFYZvY24TetD01XOPWKRPJPeH07Nen5xhh8M6k8k5yet7v9/ubaF/42W/Pf+8fCJ+x9Ga8iXCvAB+F19SVHSgcaWj9BhdXF69uoGU6gsGnt49bVp90T/x5/f4tNNHobr65fv/pA7z8q62wK/H++vXFNUvsW4HXF4NXXdmry7eXN3DeXcS9u3+vp3Uc0iWwNctJakqO81m730wlqazTo9shqfg4qV072NYZrunM2h2hM5n6EML+9r+bGJtR4GqQ4WDXBtrR7Rq41P7Z05/Uz/wIqfJvcjDCQDt8CIXgxQBa3yN9wKLjzNmxpXW4JkpNjqpe8WhCPI/1mjr5oGxg4wmsRw0nRpjAWQSj+jx/ruM43vBSgIoJDOM4HgcZbkPcj2onxHE8wg3PzhiK1NNjZehSL4SSGdSzDLTGw39egY5d6m1opJwMob1PTamzCs/5cTyerOZ6HaZbIGuN7UJpZr8Hg3hn6lpbWJOVKWXVxBLmsKohbAKkOfncbCfmMCz7HBM8WZye1ONzBavKy9Iy5XLvi+TkRJlUqNw4nzzvB55273XF25DRgpQp5jyyV5pieGX0VM5KS7CUPofbXo813sYYWE1paaVfBXuikJOvxP/HvMdhuG5G0IumpjS9Cj/pr9osNdysCkogtIgoTH5NJ9xNKdteulv4QTvcUrvud1JPTYhB3axtqb2c09HRJxTIDBoRJVPSLiDfPkcKkebUO4vZkTIj7fnFZbs7mwg5FJXi0/j0NO73Su3CxMibHMO50C21NwcPzH2A64Zo/79g/9MXbJ3NrWTfRFXGreu0HOLilHsSJ+Y4Qs49Xlyv74SjT1ZtNrxck3o4jnAhrKy615CbUv3K5cwKWYWvqtD3OFeQxVUZ5qr90se9qTqxezZ/X3bcqiof3g9uMMK7+sHI3udcEUt+zYklJhie7nw6DI5hbY1bEmCClU7+/Q3/kQBh +api: eJztWN9vGzcS/lcGfEmCrtayL+711Kc28QUG7KSxHBQHSZCp3ZGWDUWuyVkpgqD//TDkSrsrKYBb4HAv9ZOXHM4M5/vmB7UVJBdeDEZi+PlOTBKRo8+cKklZIwbiAxp0khCkycGGVan1BvAbZhUvg5FUOal7WppFJRcIhN+oR7Y3/HwHrz8OP9+9gecK3SYdm7F5LJQHNHlplSFY1No9SGDxIAeVV2bRaIaD5rhd6zzvkAdFKZvBlkLlD5ZymG2ACgRfYqbmCnNY2hx1UFfryEHNg8zTL1mGJT1BgTJHx3qMJfBIQBaeZFlqlUl24cI/66d0bH4v0MCTJ4dy+cTy5CpMgjKHvrTGI69GAcxBehiiW6HrDdEQ3KzQkIfXw+HNm1QkwpbstLLmNhcDUVpPU+OftUhEKZ1cIqFj6LbCyCWKgYj+ikQoxi56LY4h5djMrVtKAjvvuJaANciLr9pX+8Nb8wpe5ziXlaY3SXd3ZfLUlypDqVL2LV1d/hBOHMn5Z81LTI6LzK9egXX1V6mlMq/SU3FYK63BGr0Bh1Q5E5xtYD3BNCDJcXP4XCmHuRiE+AufFbiUYrAVtCk5UJ6cMgux202iMHr61eYblugG6yFuwszmGwZ90eQDfDy4IhKRWUNoiDUcB4/XTjywsz8wo46vIxGVTRJROoaeFPrgkiTpkXxzfCSkc5LtmkprPqEIl/7MDY/R/yiX6BnjvVK+lZfLUiPMnV3CmimcWePJVRlxJsYECRf8Rj8DcQorTtlwjCUKTmbOoNxizBGH7EBGsC5UVgDJmUYfgqXQQyYNkHQLpBRu52CXigjzBKTWjV/SIVQe85QvEXw4vd45bnMu7JkdXSfLipj0gT01hsqarvUh0xhqnoe4sIrAv8wuS0lqphHu7u6biMzVonJcMGpusobSRpcjmC90+WylIwszZDMrdKEsGbJ8A9YeIZtytKZoOLx5y9bMWo3SnBj7vUAq0O0B59MMpTKZrvLmHjXWZyP2PsZnAHOpPQZXQjV7gfXbeV0P4wl/VBeNJ5Q5Q7eWKjCP7XPoNQYNu5AYy5KmmcwKnH7FTTslDgHe50TX+jCQEKKGXtAAX3HDRtbS8e1rxFu4hhSPaLMvpbMrlaPr1d0jg6imkCbnREjFbpcIUqSxqR3sNn4LAWdva1qID9xFCgSyJVxDVnmyS3Q+1DJLUoOXGr1owhvi/R3g672mUIxEOB7E6oJyFLco0MulL2ZWulzs2Pdu5QwLEZ5QW676/dMS2RTkQ//0VZah9/NK679SG/e1bV/Tdu0IjrZiH6yp4rZ4efWPt9ciESFq0xi1weV1v9/v75Jj4R//+dO/+ifCVyy9m+wScdSDzrrXlNaDU2JsoPU3vLm7efcILdMJDL/cv25ZfdM98e+HT/fQQNbd/PDw6ctv8Ot/2gq7Ep8e3t88sMSxFXh/M3zXlb27vb99hOvuoji6+/faeicgXWI7u55mtmKcr9otd65Q550xpQ1JJO20Du2wncLM7YbaKqMAYX//v59al6M70J/Brg200e0auDX049u/qJ/5EfLpf8nBRATaiZdQCH4ZQut7bE5YdJ45B7a0DtdEqckR6xhPZ8gjaa8p8S/KBjY+gO244cRYDOAqgXF9nj+3aZrueCm4KgYwStN0EmSeNX+P90FI03Qsdvx8iEXq7bkydGtWUqsc6nEOWhPyn69A5y51H9oAJ0OYcOa2MnXRvD7vD6EzXMfDgA/onHVdV5rx98VOfLR1rS2dzasM8zi0NX2KPeJ5Camw+0dDeC9QIQbiYnV5Ub8golsxLyvHlCuIysHFhbaZ1IX1NPipH3javdcdb0OOK9S2XPKrJWpK4d2+b8JaUQFPvR5rfEpFYDVmlVO0CfZkqWITGk14j2F4aKbwm6amNA1NfDFfjV0beNyUOIDQIpLQ6A/DYTMA7HvsYeFs06zfBjW149e5PnmAQZm5DfjUDd5VhtQSz450oXjm0IholaHx4Vb711rJVnpXKQdZ5WiIH6Suu7NLBMMUFV+ml5dpv1cZH2aZMBBZT0tpWmofT97fxw5uGxL+/cD/vz7w60xvFYJdErNxW6fsSKwuuV9x0k4SwXnJi9vtTHr84vRux8s14UeTRKykU7Gzjbhh1T8CcNZFOr+L0Pc4jwSL6yrMXMdlkftWPHH4VeH7spNWxfnt0/BRJGJWv6c5+pwrcs2PXbkWAxF+2eDTYagMa1uxJ4EYiKiT//4L625o1g== sidebar_class_name: "post api-method" info_path: docs/api/HTTP/runtime custom_edit_url: null @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/post-search.RequestSchema.json b/website/docs/api/HTTP/post-search.RequestSchema.json new file mode 100644 index 000000000..d92d5dbda --- /dev/null +++ b/website/docs/api/HTTP/post-search.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Search request parameters","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["text"],"properties":{"additional_columns":{"type":"array","items":{"type":"string"},"description":"Additional columns to return from the dataset. If the column is a primary key, it will be\n returned within the response under `.primary_key`, not `.data`."},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets to search for similarity. If None, search across all datasets. For available datasets, use the `list_datasets` tool and ensure `can_search_documents==true`."},"limit":{"type":["integer","null"],"description":"Number of documents to return for each dataset","minimum":0},"text":{"type":"string","description":"The text to search documents for similarity"},"where":{"type":["string","null"],"description":"An SQL filter predicate to apply. Format: 'WHERE `where_cond`'."}},"title":"SearchRequestBaseJson"},{"type":"object","properties":{"keywords":{"type":["array","null"],"items":{"type":"string"}}}}],"description":"HTTP request schema is separate from AI requests, so that keywords can be supplied as an optional field for HTTP calls.\n`schemars` doesn't allow setting `#[serde(default)]` as well as `#[schemars(required)]` - the field does not become required.\nWhen the field is not required, the model ignores it.","title":"SearchRequestHTTPJson"},"example":{"datasets":["app_messages"],"text":"Tokyo plane tickets","where":"user=1234321","additional_columns":["timestamp"],"limit":3,"keywords":["plane","tickets"]}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-search.StatusCodes.json b/website/docs/api/HTTP/post-search.StatusCodes.json new file mode 100644 index 000000000..d1fa15411 --- /dev/null +++ b/website/docs/api/HTTP/post-search.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Search completed successfully","content":{"application/json":{"schema":{"type":"object","required":["results","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"Total time taken to execute the search, in milliseconds","minimum":0},"results":{"type":"array","items":{"type":"object","required":["matches","score","dataset"],"properties":{"data":{"type":"object","description":"Addditional data from the `dataset` requested by the user.","additionalProperties":{},"propertyNames":{"type":"string"}},"dataset":{"type":"string","description":"The name of the dataset where the match was found"},"matches":{"type":"object","description":"The matches for this result","additionalProperties":{"oneOf":[{},{"type":"array","items":{}}],"title":"MatchType"},"propertyNames":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{},"propertyNames":{"type":"string"}},"primary_key":{"type":"object","description":"Primary key(s) identifying the matched item in the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"score":{"type":"number","format":"double","description":"The similarity of the match to the query"}},"title":"Match"},"description":"List of matches that were found in the datasets"}},"title":"SearchResponse"},"example":{"results":[{"matches":{"message":"I booked use some tickets"},"dataset":"app_messages","primary_key":{"id":"6fd5a215-0881-421d-ace0-b293b83452b5"},"data":{"timestamp":1724716542},"score":0.914321},{"matches":{"message":"direct to Narata"},"dataset":"app_messages","primary_key":{"id":"8a25595f-99fb-4404-8c82-e1046d8f4c4b"},"data":{"timestamp":1724715881},"score":0.83221},{"matches":{"message":"Yes, we're sitting together"},"dataset":"app_messages","primary_key":{"id":"8421ed84-b86d-4b10-b4da-7a432e8912c0"},"data":{"timestamp":1724716123},"score":0.787654321}],"duration_ms":42}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{},"example":{"error":"No data sources provided"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{},"example":{"error":"Unexpected internal server error occurred"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-search.api.mdx b/website/docs/api/HTTP/post-search.api.mdx index 86385961e..b9a669f37 100644 --- a/website/docs/api/HTTP/post-search.api.mdx +++ b/website/docs/api/HTTP/post-search.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/post-sql.ParamsDetails.json b/website/docs/api/HTTP/post-sql.ParamsDetails.json new file mode 100644 index 000000000..486f83b84 --- /dev/null +++ b/website/docs/api/HTTP/post-sql.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"Accept","in":"header","description":"The format of the response, one of 'application/json' (default), 'application/vnd.spiceai.sql.v1+json', 'text/csv' or 'text/plain'.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-sql.RequestSchema.json b/website/docs/api/HTTP/post-sql.RequestSchema.json new file mode 100644 index 000000000..155e79719 --- /dev/null +++ b/website/docs/api/HTTP/post-sql.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"SQL query to execute","content":{"application/json":{"schema":{},"example":{"sql":"SELECT :foo + 1 AS the_answer","parameters":{"foo":41}}},"text/plain":{"schema":{"type":"string"},"example":"SELECT avg(total_amount), avg(tip_amount), count(1), passenger_count FROM my_table GROUP BY passenger_count ORDER BY passenger_count ASC LIMIT 3"}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-sql.StatusCodes.json b/website/docs/api/HTTP/post-sql.StatusCodes.json new file mode 100644 index 000000000..65aa96eb1 --- /dev/null +++ b/website/docs/api/HTTP/post-sql.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"SQL query executed successfully","content":{"application/json":{"schema":{"type":"array","items":{}},"example":[{"AVG(my_table.tip_amount)":3.072259971396793,"AVG(my_table.total_amount)":25.327816939456525,"COUNT(Int64(1))":31465,"passenger_count":0},{"AVG(my_table.tip_amount)":3.3712622884680057,"AVG(my_table.total_amount)":26.205230445474996,"COUNT(Int64(1))":2188739,"passenger_count":1},{"AVG(my_table.tip_amount)":3.7171302113290854,"AVG(my_table.total_amount)":29.520659930930304,"COUNT(Int64(1))":405103,"passenger_count":2}]},"text/csv":{"schema":{"type":"string"},"example":"\"AVG(my_table.tip_amount)\",\"AVG(my_table.total_amount)\",\"COUNT(Int64(1))\",\"passenger_count\"\n3.072259971396793,25.327816939456525,31465,0\n3.3712622884680057,26.205230445474996,2188739,1\n3.7171302113290854,29.520659930930304,405103,2"},"text/plain":{"schema":{"type":"string"},"example":"\n +----------------------------+----------------------------+----------------+---------------------+\n | \"AVG(my_table.tip_amount)\" | \"AVG(my_table.total_amount)\" | \"COUNT(Int64(1))\" | \"passenger_count\" |\n +----------------------------+----------------------------+----------------+---------------------+\n | 3.072259971396793 | 25.327816939456525 | 31465 | 0 |\n +----------------------------+----------------------------+----------------+---------------------+\n | 3.3712622884680057 | 26.205230445474996 | 2188739 | 1 |\n +----------------------------+----------------------------+----------------+---------------------+\n | 3.7171302113290854 | 29.520659930930304 | 405103 | 2 |\n +----------------------------+----------------------------+----------------+---------------------+"},"application/vnd.spiceai.sql.v1+json":{"schema":{},"example":{"row_count":3,"schema":{"fields":[{"name":"AVG(my_table.tip_amount)","data_type":"Float64","nullable":false,"dict_id":0,"dict_is_ordered":false},{"name":"AVG(my_table.total_amount)","data_type":"Float64","nullable":false,"dict_id":0,"dict_is_ordered":false},{"name":"COUNT(Int64(1))","data_type":"Int64","nullable":false,"dict_id":0,"dict_is_ordered":false},{"name":"passenger_count","data_type":"Int64","nullable":false,"dict_id":0,"dict_is_ordered":false}]},"data":[{"AVG(my_table.tip_amount)":3.072259971396793,"AVG(my_table.total_amount)":25.327816939456525,"COUNT(Int64(1))":31465,"passenger_count":0},{"AVG(my_table.tip_amount)":3.3712622884680057,"AVG(my_table.total_amount)":26.205230445474996,"COUNT(Int64(1))":2188739,"passenger_count":1},{"AVG(my_table.tip_amount)":3.7171302113290854,"AVG(my_table.total_amount)":29.520659930930304,"COUNT(Int64(1))":405103,"passenger_count":2}]}}}},"400":{"description":"Invalid SQL query or malformed input","content":{"text/plain":{"schema":{"type":"string"},"example":"Error reading query: invalid UTF-8 sequence"}}},"500":{"description":"Internal server error","content":{"text/plain":{"schema":{"type":"string"},"example":"Unexpected internal server error occurred"}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post-sql.api.mdx b/website/docs/api/HTTP/post-sql.api.mdx index 058ca738b..25c28636c 100644 --- a/website/docs/api/HTTP/post-sql.api.mdx +++ b/website/docs/api/HTTP/post-sql.api.mdx @@ -1,189 +1,72 @@ --- id: post-sql -title: 'SQL Query' -description: 'Execute a SQL query and return the results.' -sidebar_label: 'SQL Query' +title: "SQL Query" +description: "Execute a SQL query and return the results." +sidebar_label: "SQL Query" hide_title: true hide_table_of_contents: true api: eJztWG1v2zYQ/isEvyRFFEUvfpO+pVm6BUiXNnEGDEngstLZ5kaTCkk5MTz/9+Eou5FsNX3bsBaYvsS5O97dc3c88riklk0MTW/o1dtzeufRHEymeWG5kjSlp4+QlRYII1dvz8l9CXpBmMyJBltqSewUiAZTCmv8W3krh1NuCMi8UFxawoRQD4aUBrQhVhFYK9uo4mBIzjVkVizIWKsZYZL8Mhy+IRruSzDWJ8Mp1CxzQwygYkMKwbgkFh4t4Rs/3BryXuULn3pUFaAZwjjLaUoLZezI3Avq0YJpNgMLGmEvqWQzoCk9zjIoLPUoR9xTYDlouh0OdGes9IxZosYb9IWSBjyiJCBxjxWF4JmzfPSHUXKP7OcwZqWwL7wmdy5z3xQ8A8Z9cy/8eXjgFnhkD4EdZWa+R5Re/+cQ7yEyRMo15DS1ugSPmmwKM0bTJbWLArEYq7mc0NXqrhIGY1+qfIESTTxPoX1KD/VopqQFaVF+Gw3SPthbeRQe2awQ4Mj3AlWenp+eDEk6VoockJAcX2GcRkyaBxfQevSXdKwUTTvharXy6BPKhpFtUDWbG2NsPtm3yjIxYjNVSgy0I/HiiZDh3/3whUcKZgzICeiRo5FXlxevyWwxsuy9APLz5cX1G/Ly9x2xi8ufTi/bGMdXJ+T87PXZkMQUcTTT4whVjTjEURA8l4d1EnJiyiwDY8alEIsvSMkmWkxrhuu4hRnaXdXjdrOkx7/9vL/B7NcCRdPYD/pR1E2SfhgnvX4Se1vC9UDTNOr6cdQfhL0kTjrdXjfqevTk4vrX4f6ZtL3OfvgCdYadXhdz34gcTYOV97wrcT+MelE0GHR6gyDo9j/hS8+Pgm4UB51Ot9PvJEmvxZcoHAz6cdLiTfgpb/phP4yDKAzjKAkG3c4nvEn8bhT0ukkSB0kcxEGnxZtO0A2DuMWZaHW32ROZmX/2jrj9KIBb6m0z6/469pZ7jrbl2S29lbsl0lIFVc4DlN7JYkuiNmkJccFOoFtiuY5cRL+uddxKUvsODp/5vozZLn3QtPcXeS5RbfxmrpzATrYcdSdfaO6/RrtTMQ3ubvXUl2Id1aUDsvt9BwC3i7wBcKfe68yq8p8I4fcJcHtTNgDu7M8as9qpdenvASC2g8+4jT1z4dHqYdOt4/otbMxB5M3L5ccOFY/mzLLRuk+9EorZXod6VJZCoDBNx0wY8GjOMzviOU2DzW8zUjoHd89wMnh4tZprnEr/jsHtY61pxdG/2cb2CfnP2cCDFnX9fzH6US5Gbl7otN2kz+ScCZ7XhkalyYwJnNogJ1wWpW1ep7/i7nCqtdJEA8u5nFRmUsLXlq+Hrw4HxODYJTOgztVuu6sWtGSCGNBz0ARQ6zf7di3hsYDMOrAtBojKslJj9VdRnIGdqs2E7OYzO6UpPZqHR9W4XC2u2lmpccSbWlukR0dCZUxMlbHpIEiCnVn5HNkkhzkIVcxwbK80+eREyTGflBrIA7dT8u7wEDW+8ynOqwayUnO7cPZYwUd/Av6+Qx6XY+Xgc+uw6lJaPoPWMd218pw8iQiegTSucW/aZMGyKRxGPjrPc5CWjznoJmflUYRfKQ79MPSDw1IaV9jIxLDNmKypxdJ7izWx7dfyKbU/8sPKuvhqtbnyqspYrqvnhs5DrJx7gS9KWCJIWy7fMwPXWqxWSHaWMbMenTPNq6Z9g714/fiCBeCST0+qsB0O0TKKi9LNuNuDMLapasWH15yPy97Vav/NxdWQevT9+pFkpnJXXuwBX1vYA02pe1DC1W6Id7QlFUxOSjZB2Uonfn8D+MzJ4g== -sidebar_class_name: 'post api-method' +sidebar_class_name: "post api-method" info_path: docs/api/HTTP/runtime custom_edit_url: null proxy: http://localhost:8090 --- -import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint' -import ParamsDetails from '@theme/ParamsDetails' -import RequestSchema from '@theme/RequestSchema' -import StatusCodes from '@theme/StatusCodes' -import OperationTabs from '@theme/OperationTabs' -import TabItem from '@theme/TabItem' -import Heading from '@theme/Heading' +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Execute a SQL query and return the results. -This endpoint executes SQL queries directly from an HTTP request. The SQL query is sent as plain text in the request body. +This endpoint allows users to execute SQL queries directly from an HTTP request. The SQL query is sent as plain text in the request body. + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} +> + Request + + {...require("./post-sql.ParamsDetails.json")} +> + + + {...require("./post-sql.RequestSchema.json")} +> + + + {...require("./post-sql.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/website/docs/api/HTTP/post.ParamsDetails.json b/website/docs/api/HTTP/post.ParamsDetails.json new file mode 100644 index 000000000..98b3b8cef --- /dev/null +++ b/website/docs/api/HTTP/post.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"path","description":"Name of the tool","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/website/docs/api/HTTP/post.RequestSchema.json b/website/docs/api/HTTP/post.RequestSchema.json new file mode 100644 index 000000000..f52ef8003 --- /dev/null +++ b/website/docs/api/HTTP/post.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Tool specific input parameters. See /v1/tools for parameter schema.","content":{"application/json":{"schema":{},"example":{"query":"SELECT avg(total_amount), avg(tip_amount), count(1), passenger_count FROM my_table GROUP BY passenger_count ORDER BY passenger_count ASC LIMIT 3"}}},"required":true}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post.StatusCodes.json b/website/docs/api/HTTP/post.StatusCodes.json new file mode 100644 index 000000000..8000dcfa6 --- /dev/null +++ b/website/docs/api/HTTP/post.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Tool Specific response, in JSON format","content":{"application/json":{"schema":{},"examples":{"sql":{"value":[{"AVG(my_table.tip_amount)":3.072259971396793,"AVG(my_table.total_amount)":25.327816939456525,"COUNT(Int64(1))":31465,"passenger_count":0},{"AVG(my_table.tip_amount)":3.3712622884680057,"AVG(my_table.total_amount)":26.205230445474996,"COUNT(Int64(1))":2188739,"passenger_count":1},{"AVG(my_table.tip_amount)":3.7171302113290854,"AVG(my_table.total_amount)":29.520659930930304,"COUNT(Int64(1))":405103,"passenger_count":2}]}}}}},"404":{"description":"Tool not found","content":{"text/plain":{"schema":{"type":"string"},"example":"Tool no_sql not found"}}},"500":{"description":"Error occured whilst calling the tool","content":{"application/json":{"schema":{},"example":{"message":"Error calling tool no_sql: No such tool"}}}}}} \ No newline at end of file diff --git a/website/docs/api/HTTP/post.api.mdx b/website/docs/api/HTTP/post.api.mdx index 80631e9fa..e39595270 100644 --- a/website/docs/api/HTTP/post.api.mdx +++ b/website/docs/api/HTTP/post.api.mdx @@ -19,6 +19,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + Request diff --git a/website/docs/api/HTTP/ready.api.mdx b/website/docs/api/HTTP/ready.api.mdx index a6fe1ac4a..c06a60bdb 100644 --- a/website/docs/api/HTTP/ready.api.mdx +++ b/website/docs/api/HTTP/ready.api.mdx @@ -5,7 +5,7 @@ description: "Check the runtime status of all the components of the runtime. If sidebar_label: "Check Readiness" hide_title: true hide_table_of_contents: true -api: eJztWNtu20YQ/ZUFDRQ2oAudpECqIijSNE2NpIAbu+1DbFhLckQuQu4yu0vZqqB/75klJcqOrObyEqB+MMy9zcyeOXNZLSMvcxdN3kVvSWaL6HIQZeRSq2qvjI4m0YuC0vfCFyRso72qSDgvfeOEmQlZlmElNVVtNGkfZrf2jsRJO3Zk5yoloZywrGcglMeXb6x2Qmrx2/n5qXgUx2vh18oX4WBFzsmcxEUUzl1EQaQ2/rYE8X38eM9Z7Bfr8xf6Qp9jNaFCzpWxYoa/64I02yHTlEqy0lMmMumlI882p0Y7lZHFbBDTzc1U3liZlCTmSgaV07B8xZbQVNTSyoo82ZE4IxLvfoFECJhZcsXlYeF97SbjsauBjFQjY/NxZlI37uEcsw3DjVHGdjOdjIOgbRi0HYV7VMaSyMhLVbpw0xMtMuW8VUnDdzp0aUFZA2lH2JtR6yxIURpg4ctBs4NHGYssU0wCeHkBtEQeUDFa0A2lDYwRcg49MlGl8osegkrpqxaG9UY3BbbZzpWrmmyKq07Fh4bsoofMicPEwJGmbm04GomfecxWOFE1zmMvTA6ec01dl4qykTjluemcbGIcPfO2gRu8ETn8KHGq9GpY4q4ARebaOK9SkRg4lG7qUiqtdC5Ipq2aAODBwYF4uwHo1JqEAqq1NVmTsm3Auy7NomKHDQIE4/nxuOUJ6aw2SvsAKDBsHCCUTNge9JplBu9JccZc2BLItpN2DbzqrZzNYC6HkAnOxBpra8+so9NoeEvOgGAIz47EToDsUIIbOhBAlIa15+GGL29kVYPDr5uErCaG945xkws9nU4Xsiov9GbptFsRzONX5PlTwCe+mPQAtHPG+ol4Gv8QBznbOkOsbvgE0NkBPUlx05KOvlz9TzsY9+zxd3t4+OxpvMvmaBCZmkMQ/j7JkBbDccz2fEUOXUYaA6zuUIC9ivNpoHl0N8v+DsdUTSV0U8EJnEXTxlrYUy6GHZPWguCcD43iVMSUYQK0BAIbXINMwVHwXNw+BO8z50oFDvxaqrzwZ3+8ESlChilWSN8m6Q3szNZAshCVCozwhqXOZdkQWxczDT2U+JbPyDGcB6H6bWudE7ed+CPUa6OH/5A1azGN56R6Z+Mmpz+J4xFwWt82msxk6WgQ8fZKRpNl5Bc1g43wopws9gKQSvp26vEjTFQtrNEkXq0G+7yzdv+neanbzLXlMB4ex/HRf3msBHPmtI7Y3suWcmTnUFg22z8R6L94C7yaGAiGDR1wAbdv1Qv4ljftNyze9kmXsffj/zfnes7pg65uddUqZPCEUDcZkHvSfAmgObt0J7GH8e2TveCmIPQhXR+Rcn0E+o1OC6lzYP5JQCQG+EkdjJ9JqOm2rlaXfLw12fEB9Dv87/Ydz+50SpCDTsMzN1kH3fhxqFQ8+kg3F3qdR6tBRG2C3WSqFcCOnuxSeKJBBJXdrb8CWWM7MVPIO+RCD7CTM19t6Z64bAt+wl2bvyawIA4dBUjU3gzt314oNw3gVxvZS1oFzQCrMFwR0GKEeuALDDYVCFPc+67rQ2NLrHLJQuNXmlSWBdg54TrzEdvf8DJ6gTmVpg7NQCtpJF50rWdXP6fDIUucjiKmmAN0Fg1Z0CdrdfWe+PuS15SemXA/5VtutE3DR6o5FEJbmol+S4kxqMvnu6B9XiN6aPhoxMaDENg5U8gBt1aAEV+/FXw8Oj4excNGI8aQxnixBgCV1Fti2yfHpum6a92y9+DD6+ThdfLwOnl4nTy8TrqKtVXQkFpDtVl2NeldND8ODUz3Mw8XHp5dLhP44E9brlY83XZeXDvWream1bk3Cz+8Xu7rm3e6JRTke96IQThWI+6NP98D/7+XyechvPXO+0Kkv4E3yJ4r98+o/nqXPLAq9FvcByL0AQq3aQjy9thzRF69Dcq27MutJvfVy3P0vf8CAmPoJA== +api: eJztWNtu3DYQ/ZUBDRQ2oN3V2gmQqgiKNE1Toyngxm77YBteSpyViFCkQo423i7078VQ2osd283lJUD95BUvM8MzZ25eCZJlENm5eItSLcVlIhSGwuuGtLMiEy8rLN4BVQi+taRrhECS2gBuDtKYuFO4unEWLcXVnbNjOO6/A/qFLhB0AM96EtAEHqn1NoC08OvZ2Qkcpula+AdNVbxYYwiyRLgQ8d6FiCKto5sS4Gl69MBd6wjW9y/shT2rEHKs5EI7D3Pn4UOFlu2QRYEGvSRUoCTJgMQ2F84GrdCj6sUMa3Ndtl7mBmGhZVQ5i9tXbAnOoJFe1kjox3CKCOc/S5Lgce4xVJf7FVETsskkNLpAqcfOlxPlijDZwjlhG0Ybo5wfVgYZe1HbKGo7iO+onUdQSFKbEF96bEHpQF7nLb9pPxQVqtagP4DaKeydhVJpi4F9ExpnA0LBWCilmQTSmCXkCGVExVnAayxach7kQmojc200LbcQ1Npe9TCsD4YZSKvu3Llq0BdoaQbvW/TLLWQB9nNHFbimt+FgDD/xN1sRoG4DQSND6D0X2qYxGtUYTnhttkCfu4DPybc4A3JQIoGEujWkR0ZbBKVlaV0gXUDu1BLwujFSW21LQFn0aiKAe3t78HYD0Il3OUZUG+9UW7BtoLAxblmzw5IIwWQxnfQ8Qasapy1FQHOENqACyYTdgt6wzOg9CafMhR2BbDva0HoE8nI+10UMIRedSS5q6++so9NZswQ5J/QxPAcSB6jkAmGurQ4VKjCOtZfxha+uZd0YhN/aHL1FhveWcdmFnc1mS1mbC7vZOhl2gHn8Gol/AjSSqmwLQL/mPGXwLP0+jXJ2dcZY3fCplMQO2JIUvDN48OXqf7yDcc+PvnuAh8+fpXfZLBLhGg5B7eyxElmfjUQitnwV2flKWFmjyMQdCkQiNOfTSHNxO8v+rq2u2xpsW+foOYsWrfdoySxHA5PWgsDj+1ZzKmLKMAF6ApGD0BYFchS8gJuXoIqcM3qB8IvRZUWnf7yBwuhIsUpSn6Q3sDNbI8liVGoMQI6lLqRpka1LmYbkMaYEGTjHcB5UY3jbWxfgphN/AAnW2dE/6N1aTEucVG8d3OT0J2k6FolYv1Zkc2kCJoKP11JkK0HLhsHWlrBELxIxd76W1C8dHYqE/cCwiiztuuQh76zd/2leGg5zbdlPR9M0PfgvjxlJjP0QsVsveyx1oFhYNsc/Eei/+EgAmbsFwjRNB+Aibt+qFxJRy+v+9zS94ZMhYz+M/9+c6zmnJ0PdGqpVzOA5Fq5mQO5J80aHmF2Gm60hxneb7IGbgtiHDH1EwfVRB2htUUlbovo0IHLnDEobjZ/L1tBwtOsu+XpvcuALh2nKf26+8fRWpyQSUThLzE3Wgdc0iZWKvz7SzYXelqJLBPYJdpOpuq5LxJO7FB7bhTRa3a6/4PyNxIwx72CIPcCdnPlqSx+Iy77g59y10QdEC2nsKKZp2r/saXr0IJSbBvCrjdxK6qLmGqlyXBFKpFgPqBKZ2FQgkQjufdf1ofVGZIJLVjaZGFdIU7lAGdeZj9j+hrdB4QKNa2Iz0Esaw8uh9Rzq52w0YomzsWCKBSxar2kZ9clGX71D/n3Je9rOXXyfpp4bfdPwkWoOhdiWKtgeMbpAG5DvD0H7opFFhaPDMRuvFVrSc43+5k6XcHCHXvB0PJ2O01FrA3Ea483GBaql3RHbjxybpuu2dautBx+nk8fp5HE6eZxOHqeToWLtFLQu6avNaqhJ52IxjQ3M8G8eLjy8ulrlMuCf3nQdL/edF9eOdau5aXXuzcKP08t9ffOdbokF+Z4ZMQoXmRDcG3++B/5/k8nnIbwz530h0t/ADPLAk7dj1PZ5l/zhdey3uA9MRIVScZt2vhquvSgKbHZB2ZV9udPkvn51JrruXwJj6CQ= sidebar_class_name: "get api-method" info_path: docs/api/HTTP/runtime custom_edit_url: null diff --git a/website/docs/api/HTTP/sidebar.ts b/website/docs/api/HTTP/sidebar.ts index 78b06a980..4bf51444a 100644 --- a/website/docs/api/HTTP/sidebar.ts +++ b/website/docs/api/HTTP/sidebar.ts @@ -72,6 +72,24 @@ const sidebar: SidebarsConfig = { }, ], }, + { + type: "category", + label: "Evaluations", + items: [ + { + type: "doc", + id: "api/HTTP/list", + label: "List Evals", + className: "api-method get", + }, + { + type: "doc", + id: "api/HTTP/post-eval", + label: "Run Eval", + className: "api-method post", + }, + ], + }, { type: "category", label: "Iceberg", @@ -178,6 +196,12 @@ const sidebar: SidebarsConfig = { type: "category", label: "Tools", items: [ + { + type: "doc", + id: "api/HTTP/list", + label: "List Tools", + className: "api-method get", + }, { type: "doc", id: "api/HTTP/post",