From 2c9bc9a005041c39b3c334a1205928b025f1e451 Mon Sep 17 00:00:00 2001 From: Luke Kim <80174+lukekim@users.noreply.github.com> Date: Wed, 27 Nov 2024 18:27:27 -0800 Subject: [PATCH] Add API updates --- spiceaidocs/docs/acknowledgements/index.md | 336 +++++++++--------- spiceaidocs/docs/api/adbc/index.md | 2 +- .../docs/api/arrow-flight-sql/index.md | 4 +- spiceaidocs/docs/api/http/catalogs.md | 4 +- spiceaidocs/docs/api/http/chat-completions.md | 2 +- spiceaidocs/docs/api/http/datasets.md | 4 +- spiceaidocs/docs/api/http/embeddings.md | 2 +- spiceaidocs/docs/api/http/index.md | 4 +- spiceaidocs/docs/api/http/ml-predict.md | 4 +- spiceaidocs/docs/api/http/refresh.md | 7 +- spiceaidocs/docs/api/http/search.md | 54 +-- spiceaidocs/docs/api/jdbc/index.md | 13 +- spiceaidocs/docs/api/odbc/index.md | 16 +- 13 files changed, 227 insertions(+), 225 deletions(-) diff --git a/spiceaidocs/docs/acknowledgements/index.md b/spiceaidocs/docs/acknowledgements/index.md index 91a01502..4f7d0aa1 100644 --- a/spiceaidocs/docs/acknowledgements/index.md +++ b/spiceaidocs/docs/acknowledgements/index.md @@ -9,8 +9,6 @@ pagination_next: null Spice AI acknowledges the following open source projects for making this project possible: - - ## Go Modules github.com/AzureAD/microsoft-authentication-library-for-go/apps, https://github.com/AzureAD/microsoft-authentication-library-for-go/blob/v1.3.2/LICENSE, MIT @@ -81,424 +79,424 @@ gopkg.in/yaml.v3, https://github.com/go-yaml/yaml/blob/v3.0.1/LICENSE, MIT ## Rust Crates -- ansi_term 0.12.1, MIT +- ansi_term 0.12.1, MIT
https://github.com/ogham/rust-ansi-term -- anyhow 1.0.93, Apache-2.0 OR MIT +- anyhow 1.0.93, Apache-2.0 OR MIT
https://github.com/dtolnay/anyhow -- arrow 53.2.0, Apache-2.0 +- arrow 53.2.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-buffer 53.3.0, Apache-2.0 +- arrow-buffer 53.3.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-csv 53.3.0, Apache-2.0 +- arrow-csv 53.3.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-flight 53.2.0, Apache-2.0 +- arrow-flight 53.2.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-ipc 53.2.0, Apache-2.0 +- arrow-ipc 53.2.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-json 53.1.0, Apache-2.0 +- arrow-json 53.1.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-json 53.2.0, Apache-2.0 +- arrow-json 53.2.0, Apache-2.0
https://github.com/apache/arrow-rs -- arrow-odbc 11.2.0, MIT +- arrow-odbc 11.2.0, MIT
https://github.com/pacman82/arrow-odbc -- arrow-schema 53.3.0, Apache-2.0 +- arrow-schema 53.3.0, Apache-2.0
https://github.com/apache/arrow-rs -- async-graphql 7.0.11, Apache-2.0 OR MIT +- async-graphql 7.0.11, Apache-2.0 OR MIT
https://github.com/async-graphql/async-graphql -- async-graphql-axum 7.0.11, Apache-2.0 OR MIT +- async-graphql-axum 7.0.11, Apache-2.0 OR MIT
https://github.com/async-graphql/async-graphql -- async-openai 0.24.1, MIT +- async-openai 0.24.1, MIT
https://github.com/64bit/async-openai -- async-stream 0.3.6, MIT +- async-stream 0.3.6, MIT
https://github.com/tokio-rs/async-stream -- async-trait 0.1.83, Apache-2.0 OR MIT +- async-trait 0.1.83, Apache-2.0 OR MIT
https://github.com/dtolnay/async-trait -- aws-config 1.5.10, Apache-2.0 +- aws-config 1.5.10, Apache-2.0
https://github.com/smithy-lang/smithy-rs -- aws-sdk-secretsmanager 1.53.0, Apache-2.0 +- aws-sdk-secretsmanager 1.53.0, Apache-2.0
https://github.com/awslabs/aws-sdk-rust -- aws-sdk-sts 1.50.0, Apache-2.0 +- aws-sdk-sts 1.50.0, Apache-2.0
https://github.com/awslabs/aws-sdk-rust -- axum 0.7.9, MIT +- axum 0.7.9, MIT
https://github.com/tokio-rs/axum -- axum-extra 0.9.4, MIT +- axum-extra 0.9.4, MIT
https://github.com/tokio-rs/axum -- azure_core 0.21.0, MIT +- azure_core 0.21.0, MIT
https://github.com/azure/azure-sdk-for-rust -- azure_storage 0.21.0, MIT +- azure_storage 0.21.0, MIT
https://github.com/azure/azure-sdk-for-rust -- azure_storage_blobs 0.21.0, MIT +- azure_storage_blobs 0.21.0, MIT
https://github.com/azure/azure-sdk-for-rust -- backoff 0.4.0, Apache-2.0 OR MIT +- backoff 0.4.0, Apache-2.0 OR MIT
https://github.com/ihrwein/backoff -- base64 0.13.1, Apache-2.0 OR MIT +- base64 0.13.1, Apache-2.0 OR MIT
https://github.com/marshallpierce/rust-base64 -- base64 0.21.7, Apache-2.0 OR MIT +- base64 0.21.7, Apache-2.0 OR MIT
https://github.com/marshallpierce/rust-base64 -- base64 0.22.1, Apache-2.0 OR MIT +- base64 0.22.1, Apache-2.0 OR MIT
https://github.com/marshallpierce/rust-base64 -- bb8 0.8.6, MIT +- bb8 0.8.6, MIT
https://github.com/djc/bb8 -- bigdecimal 0.4.6, Apache-2.0 OR MIT +- bigdecimal 0.4.6, Apache-2.0 OR MIT
https://github.com/akubera/bigdecimal-rs -- bollard 0.18.1, Apache-2.0 +- bollard 0.18.1, Apache-2.0
https://github.com/fussybeaver/bollard -- byte-unit 5.1.6, MIT +- byte-unit 5.1.6, MIT
https://github.com/magiclen/byte-unit -- bytes 1.8.0, MIT +- bytes 1.8.0, MIT
https://github.com/tokio-rs/bytes -- chrono 0.4.38, Apache-2.0 OR MIT +- chrono 0.4.38, Apache-2.0 OR MIT
https://github.com/chronotope/chrono -- chrono-tz 0.8.6, Apache-2.0 OR MIT +- chrono-tz 0.8.6, Apache-2.0 OR MIT
https://github.com/chronotope/chrono-tz -- chrono-tz 0.10.0, Apache-2.0 OR MIT +- chrono-tz 0.10.0, Apache-2.0 OR MIT
https://github.com/chronotope/chrono-tz -- clap 4.5.21, Apache-2.0 OR MIT +- clap 4.5.21, Apache-2.0 OR MIT
https://github.com/clap-rs/clap -- clickhouse-rs 1.1.0-alpha.1, MIT +- clickhouse-rs 1.1.0-alpha.1, MIT
https://github.com/suharev7/clickhouse-rs -- csv 1.3.1, MIT OR Unlicense +- csv 1.3.1, MIT OR Unlicense
https://github.com/BurntSushi/rust-csv -- dashmap 6.1.0, MIT +- dashmap 6.1.0, MIT
https://github.com/xacrimon/dashmap -- datafusion 43.0.0, Apache-2.0 +- datafusion 43.0.0, Apache-2.0
https://github.com/apache/datafusion -- datafusion-federation 0.1.6, Apache-2.0 +- datafusion-federation 0.1.6, Apache-2.0
-- datafusion-federation-sql 0.1.6, Apache-2.0 +- datafusion-federation-sql 0.1.6, Apache-2.0
-- datafusion-functions-json 0.43.0, Apache-2.0 +- datafusion-functions-json 0.43.0, Apache-2.0
https://github.com/datafusion-contrib/datafusion-functions-json/ - datafusion-table-providers 0.1.0,
https://github.com/datafusion-contrib/datafusion-table-providers -- delta_kernel 0.4.1, Apache-2.0 +- delta_kernel 0.4.1, Apache-2.0
https://github.com/delta-incubator/delta-kernel-rs -- dirs 5.0.1, Apache-2.0 OR MIT +- dirs 5.0.1, Apache-2.0 OR MIT
https://github.com/soc/dirs-rs -- docx-rs 0.4.17, MIT +- docx-rs 0.4.17, MIT
https://github.com/bokuweb/docx-rs -- dotenvy 0.15.7, MIT +- dotenvy 0.15.7, MIT
https://github.com/allan2/dotenvy -- duckdb 1.1.3, MIT +- duckdb 1.1.3, MIT
https://github.com/duckdb/duckdb-rs -- dyn-clone 1.0.17, Apache-2.0 OR MIT +- dyn-clone 1.0.17, Apache-2.0 OR MIT
https://github.com/dtolnay/dyn-clone -- either 1.13.0, Apache-2.0 OR MIT +- either 1.13.0, Apache-2.0 OR MIT
https://github.com/rayon-rs/either -- fundu 2.0.1, MIT +- fundu 2.0.1, MIT
https://github.com/fundu-rs/fundu -- futures 0.3.31, Apache-2.0 OR MIT +- futures 0.3.31, Apache-2.0 OR MIT
https://github.com/rust-lang/futures-rs -- globset 0.4.15, MIT OR Unlicense +- globset 0.4.15, MIT OR Unlicense
https://github.com/BurntSushi/ripgrep/tree/master/crates/globset -- graph-rs-sdk 2.0.1, MIT +- graph-rs-sdk 2.0.1, MIT
https://github.com/sreeise/graph-rs-sdk -- graphql-parser 0.4.0, Apache-2.0 OR MIT +- graphql-parser 0.4.0, Apache-2.0 OR MIT
-- headers-accept 0.1.4, MIT +- headers-accept 0.1.4, MIT
https://github.com/maxcountryman/headers-accept -- hf-hub 0.3.2, Apache-2.0 +- hf-hub 0.3.2, Apache-2.0
https://github.com/huggingface/hf-hub -- hostname 0.3.1, MIT +- hostname 0.3.1, MIT
https://github.com/svartalf/hostname -- hostname 0.4.0, MIT +- hostname 0.4.0, MIT
https://github.com/svartalf/hostname -- http 0.2.12, Apache-2.0 OR MIT +- http 0.2.12, Apache-2.0 OR MIT
https://github.com/hyperium/http -- http 1.1.0, Apache-2.0 OR MIT +- http 1.1.0, Apache-2.0 OR MIT
https://github.com/hyperium/http -- http-body-util 0.1.2, MIT +- http-body-util 0.1.2, MIT
https://github.com/hyperium/http-body -- humantime 2.1.0, Apache-2.0 OR MIT +- humantime 2.1.0, Apache-2.0 OR MIT
https://github.com/tailhook/humantime -- hyper 0.14.31, MIT +- hyper 0.14.31, MIT
https://github.com/hyperium/hyper -- hyper 1.5.1, MIT +- hyper 1.5.1, MIT
https://github.com/hyperium/hyper -- hyper-util 0.1.10, MIT +- hyper-util 0.1.10, MIT
https://github.com/hyperium/hyper-util -- indexmap 1.9.3, Apache-2.0 OR MIT +- indexmap 1.9.3, Apache-2.0 OR MIT
https://github.com/bluss/indexmap -- indexmap 2.6.0, Apache-2.0 OR MIT +- indexmap 2.6.0, Apache-2.0 OR MIT
https://github.com/indexmap-rs/indexmap -- insta 1.41.1, Apache-2.0 +- insta 1.41.1, Apache-2.0
https://github.com/mitsuhiko/insta -- itertools 0.10.5, Apache-2.0 OR MIT +- itertools 0.10.5, Apache-2.0 OR MIT
https://github.com/rust-itertools/itertools -- itertools 0.11.0, Apache-2.0 OR MIT +- itertools 0.11.0, Apache-2.0 OR MIT
https://github.com/rust-itertools/itertools -- itertools 0.12.1, Apache-2.0 OR MIT +- itertools 0.12.1, Apache-2.0 OR MIT
https://github.com/rust-itertools/itertools -- itertools 0.13.0, Apache-2.0 OR MIT +- itertools 0.13.0, Apache-2.0 OR MIT
https://github.com/rust-itertools/itertools -- jsonpath-rust 0.7.3, MIT +- jsonpath-rust 0.7.3, MIT
https://github.com/besok/jsonpath-rust -- jsonwebtoken 9.3.0, MIT +- jsonwebtoken 9.3.0, MIT
https://github.com/Keats/jsonwebtoken -- keyring 3.6.1, Apache-2.0 OR MIT +- keyring 3.6.1, Apache-2.0 OR MIT
https://github.com/hwchen/keyring-rs.git -- lazy_static 1.5.0, Apache-2.0 OR MIT +- lazy_static 1.5.0, Apache-2.0 OR MIT
https://github.com/rust-lang-nursery/lazy-static.rs -- logos 0.14.2, Apache-2.0 OR MIT +- logos 0.14.2, Apache-2.0 OR MIT
https://github.com/maciejhirsz/logos -- lopdf 0.34.0, MIT +- lopdf 0.34.0, MIT
https://github.com/J-F-Liu/lopdf.git -- mediatype 0.19.18, MIT +- mediatype 0.19.18, MIT
https://github.com/picoHz/mediatype -- mistralrs 0.3.2, MIT +- mistralrs 0.3.2, MIT
https://github.com/EricLBuehler/mistral.rs -- mistralrs-core 0.3.2, MIT +- mistralrs-core 0.3.2, MIT
https://github.com/EricLBuehler/mistral.rs -- moka 0.12.8, Apache-2.0 OR MIT +- moka 0.12.8, Apache-2.0 OR MIT
https://github.com/moka-rs/moka -- mysql_async 0.34.2, Apache-2.0 OR MIT +- mysql_async 0.34.2, Apache-2.0 OR MIT
https://github.com/blackbeam/mysql_async -- ndarray 0.15.6, Apache-2.0 OR MIT +- ndarray 0.15.6, Apache-2.0 OR MIT
https://github.com/rust-ndarray/ndarray -- ndarray 0.16.1, Apache-2.0 OR MIT +- ndarray 0.16.1, Apache-2.0 OR MIT
https://github.com/rust-ndarray/ndarray -- notify 7.0.0, CC0-1.0 +- notify 7.0.0, CC0-1.0
https://github.com/notify-rs/notify.git -- object_store 0.11.1, Apache-2.0 OR MIT +- object_store 0.11.1, Apache-2.0 OR MIT
https://github.com/apache/arrow-rs/tree/master/object_store -- odbc-api 8.1.2, MIT +- odbc-api 8.1.2, MIT
https://github.com/pacman82/odbc-api -- once_cell 1.20.2, Apache-2.0 OR MIT +- once_cell 1.20.2, Apache-2.0 OR MIT
https://github.com/matklad/once_cell -- opentelemetry 0.26.0, Apache-2.0 +- opentelemetry 0.26.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust -- opentelemetry 0.27.0, Apache-2.0 +- opentelemetry 0.27.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust -- opentelemetry-http 0.26.0, Apache-2.0 +- opentelemetry-http 0.26.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust -- opentelemetry-prometheus 0.17.0, Apache-2.0 +- opentelemetry-prometheus 0.17.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust -- opentelemetry-proto 0.27.0, Apache-2.0 +- opentelemetry-proto 0.27.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-proto -- opentelemetry-zipkin 0.26.0, Apache-2.0 +- opentelemetry-zipkin 0.26.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-zipkin -- opentelemetry_sdk 0.26.0, Apache-2.0 +- opentelemetry_sdk 0.26.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust -- opentelemetry_sdk 0.27.0, Apache-2.0 +- opentelemetry_sdk 0.27.0, Apache-2.0
https://github.com/open-telemetry/opentelemetry-rust -- parquet 53.2.0, Apache-2.0 +- parquet 53.2.0, Apache-2.0
https://github.com/apache/arrow-rs -- paste 1.0.15, Apache-2.0 OR MIT +- paste 1.0.15, Apache-2.0 OR MIT
https://github.com/dtolnay/paste -- pin-project 1.1.7, Apache-2.0 OR MIT +- pin-project 1.1.7, Apache-2.0 OR MIT
https://github.com/taiki-e/pin-project -- pkcs8 0.10.2, Apache-2.0 OR MIT +- pkcs8 0.10.2, Apache-2.0 OR MIT
https://github.com/RustCrypto/formats/tree/master/pkcs8 -- prometheus 0.13.4, Apache-2.0 +- prometheus 0.13.4, Apache-2.0
https://github.com/tikv/rust-prometheus -- prometheus-parse 0.2.5, Apache-2.0 +- prometheus-parse 0.2.5, Apache-2.0
https://github.com/ccakes/prometheus-parse-rs -- prost 0.11.9, Apache-2.0 +- prost 0.11.9, Apache-2.0
https://github.com/tokio-rs/prost -- prost 0.12.6, Apache-2.0 +- prost 0.12.6, Apache-2.0
https://github.com/tokio-rs/prost -- prost 0.13.3, Apache-2.0 +- prost 0.13.3, Apache-2.0
https://github.com/tokio-rs/prost -- pulldown-cmark 0.12.2, MIT +- pulldown-cmark 0.12.2, MIT
https://github.com/raphlinus/pulldown-cmark -- rand 0.7.3, Apache-2.0 OR MIT +- rand 0.7.3, Apache-2.0 OR MIT
https://github.com/rust-random/rand -- rand 0.8.5, Apache-2.0 OR MIT +- rand 0.8.5, Apache-2.0 OR MIT
https://github.com/rust-random/rand -- rdkafka 0.37.0, MIT +- rdkafka 0.37.0, MIT
https://github.com/fede1024/rust-rdkafka -- regex 1.11.1, Apache-2.0 OR MIT +- regex 1.11.1, Apache-2.0 OR MIT
https://github.com/rust-lang/regex -- reqwest 0.11.27, Apache-2.0 OR MIT +- reqwest 0.11.27, Apache-2.0 OR MIT
https://github.com/seanmonstar/reqwest -- reqwest 0.12.9, Apache-2.0 OR MIT +- reqwest 0.12.9, Apache-2.0 OR MIT
https://github.com/seanmonstar/reqwest -- reqwest-eventsource 0.6.0, Apache-2.0 OR MIT +- reqwest-eventsource 0.6.0, Apache-2.0 OR MIT
https://github.com/jpopesculian/reqwest-eventsource -- rusqlite 0.31.0, MIT +- rusqlite 0.31.0, MIT
https://github.com/rusqlite/rusqlite -- rustls 0.21.12, Apache-2.0 OR ISC OR MIT +- rustls 0.21.12, Apache-2.0 OR ISC OR MIT
https://github.com/rustls/rustls -- rustls 0.23.18, Apache-2.0 OR ISC OR MIT +- rustls 0.23.18, Apache-2.0 OR ISC OR MIT
https://github.com/rustls/rustls -- rustls-native-certs 0.6.3, Apache-2.0 OR ISC OR MIT +- rustls-native-certs 0.6.3, Apache-2.0 OR ISC OR MIT
https://github.com/ctz/rustls-native-certs -- rustls-native-certs 0.8.1, Apache-2.0 OR ISC OR MIT +- rustls-native-certs 0.8.1, Apache-2.0 OR ISC OR MIT
https://github.com/rustls/rustls-native-certs -- rustls-pemfile 1.0.4, Apache-2.0 OR ISC OR MIT +- rustls-pemfile 1.0.4, Apache-2.0 OR ISC OR MIT
https://github.com/rustls/pemfile -- rustls-pemfile 2.2.0, Apache-2.0 OR ISC OR MIT +- rustls-pemfile 2.2.0, Apache-2.0 OR ISC OR MIT
https://github.com/rustls/pemfile -- rustyline 15.0.0, MIT +- rustyline 15.0.0, MIT
https://github.com/kkawakam/rustyline -- schemars 0.8.21, MIT +- schemars 0.8.21, MIT
https://github.com/GREsau/schemars -- scopeguard 1.2.0, Apache-2.0 OR MIT +- scopeguard 1.2.0, Apache-2.0 OR MIT
https://github.com/bluss/scopeguard -- secrecy 0.8.0, Apache-2.0 OR MIT +- secrecy 0.8.0, Apache-2.0 OR MIT
https://github.com/iqlusioninc/crates/tree/main/secrecy -- serde 1.0.215, Apache-2.0 OR MIT +- serde 1.0.215, Apache-2.0 OR MIT
https://github.com/serde-rs/serde -- serde-value 0.7.0, MIT +- serde-value 0.7.0, MIT
https://github.com/arcnmx/serde-value -- serde_json 1.0.132, Apache-2.0 OR MIT +- serde_json 1.0.132, Apache-2.0 OR MIT
https://github.com/serde-rs/json -- serde_yaml 0.9.34+deprecated, Apache-2.0 OR MIT +- serde_yaml 0.9.34+deprecated, Apache-2.0 OR MIT
https://github.com/dtolnay/serde-yaml -- sha2 0.10.8, Apache-2.0 OR MIT +- sha2 0.10.8, Apache-2.0 OR MIT
https://github.com/RustCrypto/hashes -- snafu 0.8.5, Apache-2.0 OR MIT +- snafu 0.8.5, Apache-2.0 OR MIT
https://github.com/shepmaster/snafu -- snmalloc-rs 0.3.6, MIT +- snmalloc-rs 0.3.6, MIT
https://github.com/SchrodingerZhu/snmalloc-rs -- snowflake-api 0.9.0, Apache-2.0 +- snowflake-api 0.9.0, Apache-2.0
https://github.com/mycelial/snowflake-rs -- spark-connect-rs 0.0.1-beta.4, Apache-2.0 +- spark-connect-rs 0.0.1-beta.4, Apache-2.0
https://github.com/sjrusso8/spark-connect-rs -- ssh2 0.9.4, Apache-2.0 OR MIT +- ssh2 0.9.4, Apache-2.0 OR MIT
https://github.com/alexcrichton/ssh2-rs -- suppaftp 5.4.0, Apache-2.0 +- suppaftp 5.4.0, Apache-2.0
https://github.com/veeso/suppaftp -- tempfile 3.14.0, Apache-2.0 OR MIT +- tempfile 3.14.0, Apache-2.0 OR MIT
https://github.com/Stebalien/tempfile - text-embeddings-backend 1.5.0, @@ -513,86 +511,86 @@ gopkg.in/yaml.v3, https://github.com/go-yaml/yaml/blob/v3.0.1/LICENSE, MIT - text-embeddings-core 1.5.0,
-- text-splitter 0.18.1, MIT +- text-splitter 0.18.1, MIT
https://github.com/benbrandt/text-splitter -- tiberius 0.12.3, Apache-2.0 OR MIT +- tiberius 0.12.3, Apache-2.0 OR MIT
https://github.com/prisma/tiberius -- tiktoken-rs 0.6.0, MIT +- tiktoken-rs 0.6.0, MIT
https://github.com/zurawiki/tiktoken-rs -- tokenizers 0.20.3, Apache-2.0 +- tokenizers 0.20.3, Apache-2.0
https://github.com/huggingface/tokenizers -- tokio 1.41.1, MIT +- tokio 1.41.1, MIT
https://github.com/tokio-rs/tokio -- tokio-postgres 0.7.12, Apache-2.0 OR MIT +- tokio-postgres 0.7.12, Apache-2.0 OR MIT
https://github.com/sfackler/rust-postgres -- tokio-rusqlite 0.5.1, MIT +- tokio-rusqlite 0.5.1, MIT
https://github.com/programatik29/tokio-rusqlite -- tokio-rustls 0.24.1, Apache-2.0 OR MIT +- tokio-rustls 0.24.1, Apache-2.0 OR MIT
https://github.com/rustls/tokio-rustls -- tokio-rustls 0.26.0, Apache-2.0 OR MIT +- tokio-rustls 0.26.0, Apache-2.0 OR MIT
https://github.com/rustls/tokio-rustls -- tokio-stream 0.1.16, MIT +- tokio-stream 0.1.16, MIT
https://github.com/tokio-rs/tokio -- tokio-util 0.7.12, MIT +- tokio-util 0.7.12, MIT
https://github.com/tokio-rs/tokio -- tonic 0.12.3, MIT +- tonic 0.12.3, MIT
https://github.com/hyperium/tonic -- tonic-health 0.12.3, MIT +- tonic-health 0.12.3, MIT
https://github.com/hyperium/tonic -- tower 0.4.13, MIT +- tower 0.4.13, MIT
https://github.com/tower-rs/tower -- tower 0.5.1, MIT +- tower 0.5.1, MIT
https://github.com/tower-rs/tower -- tower-http 0.6.2, MIT +- tower-http 0.6.2, MIT
https://github.com/tower-rs/tower-http -- tracing 0.1.40, MIT +- tracing 0.1.40, MIT
https://github.com/tokio-rs/tracing -- tracing-futures 0.2.5, MIT +- tracing-futures 0.2.5, MIT
https://github.com/tokio-rs/tracing -- tracing-opentelemetry 0.27.0, MIT +- tracing-opentelemetry 0.27.0, MIT
https://github.com/tokio-rs/tracing-opentelemetry -- tracing-subscriber 0.3.18, MIT +- tracing-subscriber 0.3.18, MIT
https://github.com/tokio-rs/tracing -- tract-core 0.21.7, Apache-2.0 OR MIT +- tract-core 0.21.7, Apache-2.0 OR MIT
https://github.com/snipsco/tract -- tract-onnx 0.21.7, Apache-2.0 OR MIT +- tract-onnx 0.21.7, Apache-2.0 OR MIT
https://github.com/snipsco/tract -- trust-dns-resolver 0.23.2, Apache-2.0 OR MIT +- trust-dns-resolver 0.23.2, Apache-2.0 OR MIT
https://github.com/bluejekyll/trust-dns -- url 2.5.4, Apache-2.0 OR MIT +- url 2.5.4, Apache-2.0 OR MIT
https://github.com/servo/rust-url -- uuid 0.8.2, Apache-2.0 OR MIT +- uuid 0.8.2, Apache-2.0 OR MIT
https://github.com/uuid-rs/uuid -- uuid 1.11.0, Apache-2.0 OR MIT +- uuid 1.11.0, Apache-2.0 OR MIT
https://github.com/uuid-rs/uuid -- winver 1.0.0, MIT +- winver 1.0.0, MIT
https://github.com/rhysd/winver -- x509-certificate 0.23.1, MPL-2.0 +- x509-certificate 0.23.1, MPL-2.0
https://github.com/indygreg/cryptography-rs.git diff --git a/spiceaidocs/docs/api/adbc/index.md b/spiceaidocs/docs/api/adbc/index.md index e3c44f02..1387d194 100644 --- a/spiceaidocs/docs/api/adbc/index.md +++ b/spiceaidocs/docs/api/adbc/index.md @@ -17,7 +17,7 @@ Get started with ADBC using Python. ### Installation -Start Python Envionment. +Start a Python environment. ```shell python diff --git a/spiceaidocs/docs/api/arrow-flight-sql/index.md b/spiceaidocs/docs/api/arrow-flight-sql/index.md index 85f45c66..43cafaa1 100644 --- a/spiceaidocs/docs/api/arrow-flight-sql/index.md +++ b/spiceaidocs/docs/api/arrow-flight-sql/index.md @@ -7,10 +7,10 @@ description: 'Query Spice using JDBC/ODBC/ADBC' [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) is a protocol for interacting with SQL databases using the Arrow in-memory format and the Flight RPC framework. -Spice implements the Flight SQL protocol which enables querying the datasets configured in Spice via tools that support connecting via one of the Arrow Flight SQL drivers, such as [DBeaver](https://dbeaver.io), [Tableau](https://www.tableau.com/), or [Power BI](https://www.microsoft.com/en-us/power-platform/products/power-bi). +Spice implements the Flight SQL protocol, enabling querying of the datasets configured in Spice via tools that support connecting via one of the Arrow Flight SQL drivers, such as [DBeaver](https://dbeaver.io), [Tableau](https://www.tableau.com/), or [Power BI](https://www.microsoft.com/en-us/power-platform/products/power-bi). arrow flight and spice ## Authentication -API Key authentication is supported for the Arrow Flight SQL endpoint. See [API Key Authentication](../../api/auth/index.md) for more details. +API Key authentication is supported for the Arrow Flight SQL endpoint. For more details, see [API Key Authentication](../../api/auth/index.md). diff --git a/spiceaidocs/docs/api/http/catalogs.md b/spiceaidocs/docs/api/http/catalogs.md index 1dc1bde7..859e0933 100644 --- a/spiceaidocs/docs/api/http/catalogs.md +++ b/spiceaidocs/docs/api/http/catalogs.md @@ -5,9 +5,9 @@ description: 'Fetch catalogs' sidebar_position: 5 --- -Returns the list of configured [catalogs](/components/catalogs) +The `GET /v1/catalogs` endpoint returns a list of configured catalogs. -Example: +Example request: ```bash curl --request GET \ diff --git a/spiceaidocs/docs/api/http/chat-completions.md b/spiceaidocs/docs/api/http/chat-completions.md index 1192ddef..7d6f1804 100644 --- a/spiceaidocs/docs/api/http/chat-completions.md +++ b/spiceaidocs/docs/api/http/chat-completions.md @@ -5,7 +5,7 @@ description: '' sidebar_position: 6 --- -Chat completions is an OpenAI compatible endpoint. +The `POST /v1/chat/completions` endpoint is an OpenAI compatible endpoint for generating chat completions. Specify the model by providing the component name in the `model` key. For example: diff --git a/spiceaidocs/docs/api/http/datasets.md b/spiceaidocs/docs/api/http/datasets.md index aeabd6d7..fd9e4bc9 100644 --- a/spiceaidocs/docs/api/http/datasets.md +++ b/spiceaidocs/docs/api/http/datasets.md @@ -5,9 +5,9 @@ description: 'Fetch datasets' sidebar_position: 2 --- -Returns a the list of configured datasets. +The `GET /v1/datasets` endpoint returns a list of configured datasets. -Example: +Example request: ```bash curl --request GET \ diff --git a/spiceaidocs/docs/api/http/embeddings.md b/spiceaidocs/docs/api/http/embeddings.md index 85d049d3..9a640087 100644 --- a/spiceaidocs/docs/api/http/embeddings.md +++ b/spiceaidocs/docs/api/http/embeddings.md @@ -5,7 +5,7 @@ description: '' sidebar_position: 7 --- -Chat completions is an OpenAI compatible endpoint. +The `POST /v1/embeddings` endpoint is an OpenAI compatible endpoint for generating embeddings. Specify the embedding model by providing the component name in the `model` key. For example: diff --git a/spiceaidocs/docs/api/http/index.md b/spiceaidocs/docs/api/http/index.md index 9f682ccd..4e165736 100644 --- a/spiceaidocs/docs/api/http/index.md +++ b/spiceaidocs/docs/api/http/index.md @@ -13,11 +13,11 @@ import DocCardList from '@theme/DocCardList'; ## Authentication -API Key authentication is supported for all HTTP routes. See [API Key Authentication](../../api/auth/index.md) for more details. +API Key authentication is supported for all HTTP routes. For more details, see [API Key Authentication](../../api/auth/index.md). ## Cross-Origin Resource Sharing (CORS) -CORS is disabled by default. Enable for all origins with: +CORS is disabled by default. To enable CORS for all origins, add the following configuration to your `spicepod.yaml` file: ```yaml runtime: diff --git a/spiceaidocs/docs/api/http/ml-predict.md b/spiceaidocs/docs/api/http/ml-predict.md index a87d1d3c..feff2bb5 100644 --- a/spiceaidocs/docs/api/http/ml-predict.md +++ b/spiceaidocs/docs/api/http/ml-predict.md @@ -8,9 +8,9 @@ sidebar_position: 10 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Make predictions using all loaded forecasting models in parallel, useful for ensembling or A/B testing. +The `POST /v1/predict` endpoint is used to make predictions using all loaded forecasting models in parallel. This is useful for ensembling or A/B testing different models. -Example: +Example request: ```shell curl --request POST \ diff --git a/spiceaidocs/docs/api/http/refresh.md b/spiceaidocs/docs/api/http/refresh.md index a9f49229..596d4f2b 100644 --- a/spiceaidocs/docs/api/http/refresh.md +++ b/spiceaidocs/docs/api/http/refresh.md @@ -10,10 +10,11 @@ pagination_next: null Performs an on-demand refresh for an accelerated dataset. On-demand refresh applies only to `full` and `append` refresh modes (not `changes`). Request Body: - - `refresh_sql` (String, Optional): Refresh SQL to use, see [Refresh SQL docs](/components/data-accelerators/data-refresh.md#refresh-sql). Defaults to the `refresh_sql` specified in the spicepod. - - `refresh_mode` (String, Optional): Refresh mode to use, see [Refresh Modes docs](/components/data-accelerators/data-refresh.md#refresh-modes). Defaults to `refresh_mode` specified in the spicepod. - Example: +- `refresh_sql` (String, Optional): Refresh SQL to use, see [Refresh SQL docs](/components/data-accelerators/data-refresh.md#refresh-sql). Defaults to the `refresh_sql` specified in the spicepod. +- `refresh_mode` (String, Optional): Refresh mode to use, see [Refresh Modes docs](/components/data-accelerators/data-refresh.md#refresh-modes). Defaults to `refresh_mode` specified in the spicepod. + +Example: ```bash curl -i -XPOST 127.0.0.1:8090/v1/datasets/taxi_trips/acceleration/refresh \ diff --git a/spiceaidocs/docs/api/http/search.md b/spiceaidocs/docs/api/http/search.md index 9b3e54c4..30a6ed65 100644 --- a/spiceaidocs/docs/api/http/search.md +++ b/spiceaidocs/docs/api/http/search.md @@ -10,15 +10,17 @@ pagination_next: null Performs a basic vector similarity search across one or more datasets. Request Body - - `datasets` (array of strings, Optional): Names of the dataset components to perform the similarity search on. Each dataset must have exactly one column augmented with an embedding. If None, all available datasets are used. - - `text` (string): Query plaintext used to retrieve similar rows from the underlying datasets listed in the `from` request key. - - `limit` (integer): The number of rows to return, per `from` dataset. Default: 3. - - `where` (string): An SQL filter predicate to apply within the search. - - `additional_columns` (array of strings): Additional columns, from the datasets, to return in the response (under `.matches[*].metadata`). + +- `datasets` (array of strings, Optional): Names of the dataset components to perform the similarity search on. Each dataset must have exactly one column augmented with an embedding. If None, all available datasets are used. +- `text` (string): Query plaintext used to retrieve similar rows from the underlying datasets listed in the `from` request key. +- `limit` (integer): The number of rows to return, per `from` dataset. Default: 3. +- `where` (string): An SQL filter predicate to apply within the search. +- `additional_columns` (array of strings): Additional columns, from the datasets, to return in the response (under `.matches[*].metadata`). #### Example Spicepod + ```yaml embeddings: - name: embedding_maker @@ -34,6 +36,7 @@ datasets: ``` Request + ```shell curl -XPOST http://localhost:3000/v1/search \ -d '{ @@ -46,27 +49,30 @@ curl -XPOST http://localhost:3000/v1/search \ ``` Response + ```json { - "matches": [{ - "value": "I booked use some tickets", - "dataset": "app_messages", - "primary_key": {"id": "6fd5a215-0881-421d-ace0-b293b83452b5"}, - "metadata": {"timestamp": 1724716542} - }, - { - "value": "direct to Narata", - "dataset": "app_messages", - "primary_key": {"id": "8a25595f-99fb-4404-8c82-e1046d8f4c4b"}, - "metadata": {"timestamp": 1724715881} - }, - { - "value": "Yes, we're sitting together", - "dataset": "app_messages", - "primary_key": {"id": "8421ed84-b86d-4b10-b4da-7a432e8912c0"}, - "metadata": {"timestamp": 1724716123} - }], - "duration_ms": 42, + "matches": [ + { + "value": "I booked use some tickets", + "dataset": "app_messages", + "primary_key": { "id": "6fd5a215-0881-421d-ace0-b293b83452b5" }, + "metadata": { "timestamp": 1724716542 } + }, + { + "value": "direct to Narata", + "dataset": "app_messages", + "primary_key": { "id": "8a25595f-99fb-4404-8c82-e1046d8f4c4b" }, + "metadata": { "timestamp": 1724715881 } + }, + { + "value": "Yes, we're sitting together", + "dataset": "app_messages", + "primary_key": { "id": "8421ed84-b86d-4b10-b4da-7a432e8912c0" }, + "metadata": { "timestamp": 1724716123 } + } + ], + "duration_ms": 42 } ``` diff --git a/spiceaidocs/docs/api/jdbc/index.md b/spiceaidocs/docs/api/jdbc/index.md index 1ee2514c..a15fec95 100644 --- a/spiceaidocs/docs/api/jdbc/index.md +++ b/spiceaidocs/docs/api/jdbc/index.md @@ -16,17 +16,14 @@ Spice supports JDBC clients through a JDBC driver implementation based on the [F ### Download the Flight SQL JDBC driver - Find the appropriate [Flight SQL JDBC driver](https://central.sonatype.com/artifact/org.apache.arrow/flight-sql-jdbc-driver/versions) version. -- Click **Browse** next to the version you want to download +- Click **Browse** next to the version you want to download - Click the `flight-sql-jdbc-driver-XX.XX.XX.jar` file (with only the `.jar` file extension) from the list of files to download the driver jar file ### Add the driver to your application Follow the instructions specific to your application for adding a custom JDBC driver. Examples: -**Tableau**: - - Windows: `C:\Program Files\Tableau\Drivers` - - Mac: `~/Library/Tableau/Drivers` - - Linux: `/opt/tableau/tableau_driver/jdbc` - Start or restart Tableau +**Tableau**: - Windows: `C:\Program Files\Tableau\Drivers` - Mac: `~/Library/Tableau/Drivers` - Linux: `/opt/tableau/tableau_driver/jdbc` - Start or restart Tableau [Full instruction](/clients/tableau) @@ -51,8 +48,8 @@ Follow the instructions specific to your application for adding a custom JDBC dr - **URL**: `jdbc:arrow-flight-sql://{host}:{port}` - **Dialect**: `PostgreSQL` - For example: - +For example: + 1. **Ensure Spice is running** 1. Click **Connect** @@ -75,4 +72,4 @@ Replace `` with the API key value. The `user` and `password` In the configured application, run a sample query, such as `SELECT * FROM taxi_trips;` -![Query Results](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/0e9f3c0f-2e03-47f9-8d5e-65e078d7e900/public "Query Results") +![Query Results](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/0e9f3c0f-2e03-47f9-8d5e-65e078d7e900/public 'Query Results') diff --git a/spiceaidocs/docs/api/odbc/index.md b/spiceaidocs/docs/api/odbc/index.md index 31a65b09..93932df0 100644 --- a/spiceaidocs/docs/api/odbc/index.md +++ b/spiceaidocs/docs/api/odbc/index.md @@ -81,14 +81,14 @@ Spice supports ODBC clients through an ODBC driver implementation based on the [ ### ODBC Connection Parameters -| Name | Type | Description | -|-|-|-| -| host | string | The IP address or hostname for the Spice runtime. | -| port | integer | The Spice runtime Arrow Flight endpoint port number | -| useEncryption | integer | Configures the driver to use an SSL-encrypted connection. Accepted values: `true` (default) - The client communicates with the Spice runtime only using SSL encryption and `false` - SSL encryption is disabled. | -| disableCertificateVerification | integer | Specifies whether the driver should verify the host certificate against the trust store. Default is `false`| -| useSystemTrustStore | integer | Controls whether to use a CA certificate from the system's trust store, or from a specified .pem file. If `true` - The driver verifies the connection using a certificate in the system trust store. IF `false` - The driver verifies the connection using the .pem file specified by the `trustedCerts` parameter. `true` on Windows and macOS, `false` on Linux by default | -| trustedCerts | string | The full path of the .pem file containing certificates trusted by a CA, for the purpose of verifying the server. If this option is not set, then the driver defaults to using the trusted CA certificates .pem file installed by the driver. | +| Name | Type | Description | +| ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| host | string | The IP address or hostname for the Spice runtime. | +| port | integer | The Spice runtime Arrow Flight endpoint port number | +| useEncryption | integer | Configures the driver to use an SSL-encrypted connection. Accepted values: `true` (default) - The client communicates with the Spice runtime only using SSL encryption and `false` - SSL encryption is disabled. | +| disableCertificateVerification | integer | Specifies whether the driver should verify the host certificate against the trust store. Default is `false` | +| useSystemTrustStore | integer | Controls whether to use a CA certificate from the system's trust store, or from a specified .pem file. If `true` - The driver verifies the connection using a certificate in the system trust store. IF `false` - The driver verifies the connection using the .pem file specified by the `trustedCerts` parameter. `true` on Windows and macOS, `false` on Linux by default | +| trustedCerts | string | The full path of the .pem file containing certificates trusted by a CA, for the purpose of verifying the server. If this option is not set, then the driver defaults to using the trusted CA certificates .pem file installed by the driver. | :::note The ODBC driver for Arrow Flight SQL does not support password-protected `.pem/.crt` files or multiple `.crt` certificates in a single `.pem/.crt` file.