kamp0010 commited on
Commit
7a451cd
·
verified ·
1 Parent(s): 901c182

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -7
README.md CHANGED
@@ -1,12 +1,38 @@
1
  ---
2
- title: Test
3
- emoji:
4
- colorFrom: red
5
- colorTo: green
6
- sdk: gradio
7
- sdk_version: 6.8.0
8
  app_file: app.py
9
  pinned: false
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Code Search Client
3
+ colorFrom: blue
4
+ colorTo: indigo
5
+ sdk: streamlit
6
+ sdk_version: "1.35.0"
 
7
  app_file: app.py
8
  pinned: false
9
+ license: mit
10
  ---
11
 
12
+ # Code Search Client
13
+
14
+ A Streamlit UI for the [Code Search API](https://huggingface.co/spaces/YOUR_USER/code-search-api).
15
+
16
+ ## Setup
17
+
18
+ 1. Deploy the **Code Search API** Space first (the FastAPI backend).
19
+ 2. Deploy this Space.
20
+ 3. Open the app and paste your API Space URL into the sidebar (e.g. `https://your-user-code-search-api.hf.space`).
21
+
22
+ ## Features
23
+
24
+ | Tab | Description |
25
+ |---|---|
26
+ | 🔍 Search | Query any indexed document or project |
27
+ | 📄 Index File | Upload a single source file to index |
28
+ | 📦 Batch Index | Upload a whole project (multiple files) under one doc_id |
29
+ | 🗂 Documents | Browse and delete indexed documents |
30
+ | 🧮 Embed | Get raw 768-dim embeddings for any text |
31
+
32
+ ## Tip — pre-configure the API URL
33
+
34
+ Set the `API_URL` environment variable in your Space secrets to pre-fill the sidebar:
35
+
36
+ ```
37
+ API_URL=https://your-user-code-search-api.hf.space
38
+ ```