From ce11a2ff4d9696da19e7c5845e40b535f1ae8239 Mon Sep 17 00:00:00 2001 From: Jacek Laskowski Date: Fri, 11 Oct 2024 20:05:29 +0200 Subject: [PATCH] UC AI Python lib + New server cmd options --- docs/ai/BaseFunctionClient.md | 3 +++ docs/ai/DatabricksFunctionClient.md | 14 ++++++++++++++ docs/ai/index.md | 12 ++++++++++++ docs/server/index.md | 8 ++++++-- 4 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 docs/ai/BaseFunctionClient.md create mode 100644 docs/ai/DatabricksFunctionClient.md diff --git a/docs/ai/BaseFunctionClient.md b/docs/ai/BaseFunctionClient.md new file mode 100644 index 0000000..28549fa --- /dev/null +++ b/docs/ai/BaseFunctionClient.md @@ -0,0 +1,3 @@ +# BaseFunctionClient + +`BaseFunctionClient` is...FIXME diff --git a/docs/ai/DatabricksFunctionClient.md b/docs/ai/DatabricksFunctionClient.md new file mode 100644 index 0000000..43b859b --- /dev/null +++ b/docs/ai/DatabricksFunctionClient.md @@ -0,0 +1,14 @@ +# DatabricksFunctionClient + +`DatabricksFunctionClient` is a [BaseFunctionClient](BaseFunctionClient.md). + +## create_function + +``` py +create_function( + self, + *, + sql_function_body: Optional[str] = None, + function_info: Optional["CreateFunction"] = None, +) -> "FunctionInfo" +``` diff --git a/docs/ai/index.md b/docs/ai/index.md index 97e8eb4..42cd079 100644 --- a/docs/ai/index.md +++ b/docs/ai/index.md @@ -4,3 +4,15 @@ !!! note Unity Catalog AI Core Library was added to Unity Catalog as part of [this commit]({{ uc.commit }}/6842634b2fd262e1bee6382f1cd28e36caf3a78c). + +## Databricks Function Client Support + +[DatabricksFunctionClient](DatabricksFunctionClient.md) + +```python +from ucai.core.databricks import DatabricksFunctionClient +client = DatabricksFunctionClient() +``` + +!!! note + Added in [this commit]({{ uc.commit }}/7d7e4b24280adef7e2c163de91107611fa403ec3). diff --git a/docs/server/index.md b/docs/server/index.md index 0802eb4..174208e 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -2,8 +2,12 @@ Unity Catalog comes with **Localhost Reference Server** that can be launched on command line using `./bin/start-uc-server` utility. -```console -./bin/start-uc-server [-p|--port port] +``` console +❯ ./bin/start-uc-server -h +usage: bin/start-uc-server + -h,--help Print help message. + -p,--port Port number to run the server on. Default is 8080. + -v,--version Display the version of the Unity Catalog server ``` `start-uc-server` runs [UnityCatalogServer](UnityCatalogServer.md) to [handle REST API requests](UnityCatalogServer.md#addServices) at a [port](UnityCatalogServer.md#port) (specified using `-p` or `--port` option or defaults to `8080`).