From 9980ab0aa6a18d3485b109a5d010b340a2084705 Mon Sep 17 00:00:00 2001 From: Shicheng Liu Date: Sun, 7 Apr 2024 06:47:32 +0000 Subject: [PATCH] update `install_pip.md` --- docs/install_pip.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/install_pip.md b/docs/install_pip.md index 348c6f6..964b3f2 100644 --- a/docs/install_pip.md +++ b/docs/install_pip.md @@ -90,5 +90,11 @@ You should be good to go! In a separate terminal, run `export OPENAI_API_KEY=[yo from suql import suql_execute # e.g. suql = "SELECT * FROM restaurants WHERE answer(reviews, 'is this a family-friendly restaurant?') = 'Yes' AND rating = 4;" suql = "Your favorite SUQL" -suql_execute(suql) -``` \ No newline at end of file + +# e.g. table_w_ids = {"restaurants": "_id"} +table_w_ids = "mapping between table name -> unique ID column name" + +suql_execute(suql, table_w_ids) +``` + +Check out [API documentation](https://stanford-oval.github.io/suql/suql/sql_free_text_support/execute_free_text_sql.html) for details. \ No newline at end of file