mtyrrell commited on
Commit
b849e62
·
1 Parent(s): 454dc04
Files changed (1) hide show
  1. README.md +3 -26
README.md CHANGED
@@ -28,11 +28,11 @@ The main MCP function is `retrieve_mcp` which provides a top_k retrieval and rer
28
  - `answer_metadata`: Document metadata
29
  - `score`: Relevance score [disabled when reranker used]
30
 
31
-
32
  ```python
33
  from gradio_client import Client
34
 
35
- client = Client("https://mtyrrell-chatfed-retriever.hf.space/")
36
  result = client.predict(
37
  query="...",
38
  reports_filter="",
@@ -44,7 +44,7 @@ result = client.predict(
44
  print(result)
45
  ```
46
 
47
- ## ⚙️ Configuration
48
 
49
  ### Vector Store Configuration
50
  1. Set your data source according to the provider
@@ -58,27 +58,4 @@ docker build -t chatfed-retriever .
58
  docker run -p 7860:7860 chatfed-retriever
59
  ```
60
 
61
- 6. Test connection
62
-
63
- ```python
64
- from gradio_client import Client
65
-
66
- def test_retrieve_mcp():
67
- client = Client("ENTER CONTAINER URL")
68
-
69
- # Make a simple query
70
- result = client.predict(
71
- query="Return all audit reports relating to climate change?",
72
- reports_filter="",
73
- sources_filter="",
74
- subtype_filter="",
75
- year_filter="",
76
- api_name="/retrieve_mcp"
77
- )
78
-
79
- print(result)
80
-
81
- if __name__ == "__main__":
82
- test_retrieve_mcp()
83
- ```
84
 
 
28
  - `answer_metadata`: Document metadata
29
  - `score`: Relevance score [disabled when reranker used]
30
 
31
+ **Example useage**:
32
  ```python
33
  from gradio_client import Client
34
 
35
+ client = Client("ENTER CONTAINER URL / SPACE ID")
36
  result = client.predict(
37
  query="...",
38
  reports_filter="",
 
44
  print(result)
45
  ```
46
 
47
+ ## Configuration
48
 
49
  ### Vector Store Configuration
50
  1. Set your data source according to the provider
 
58
  docker run -p 7860:7860 chatfed-retriever
59
  ```
60
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61