You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,20 @@
1
-
# pgpt-python: Python SDK for PrivateGPT API
1
+
# pgpt_python: Python SDK for PrivateGPT API
2
2
3
-
**pgpt-python** is an open-source Python SDK designed to interact with the PrivateGPT API. PrivateGPT is a popular AI Open Source project that provides secure and private access to advanced natural language processing capabilities. This SDK simplifies the integration of PrivateGPT into Python applications, allowing developers to harness the power of PrivateGPT for various language-related tasks.
3
+
**pgpt_python** is an open-source Python SDK designed to interact with the PrivateGPT API. PrivateGPT is a popular AI Open Source project that provides secure and private access to advanced natural language processing capabilities. This SDK simplifies the integration of PrivateGPT into Python applications, allowing developers to harness the power of PrivateGPT for various language-related tasks.
4
4
5
5
This SDK has been created using [Fern](https://buildwithfern.com/).
6
6
7
7
## Installation
8
8
9
-
To install the pgpt-python SDK, use the following pip command:
9
+
To install the pgpt_python SDK, use the following pip command:
10
10
11
11
```bash
12
-
pip install pgpt-python
12
+
pip install pgpt_python
13
13
```
14
14
15
15
## Getting Started
16
16
17
-
To begin using pgpt-python with the PrivateGPT API, follow these steps:
17
+
To begin using pgpt_python with the PrivateGPT API, follow these steps:
18
18
19
19
1.**Import the PrivateGPTApi class:**
20
20
@@ -32,7 +32,7 @@ To begin using pgpt-python with the PrivateGPT API, follow these steps:
32
32
33
33
## Perform API Calls
34
34
35
-
Once you have set up the PrivateGPTApi instance, you can perform various API calls using the pgpt-pythonSDK. Below are examples of common API calls:
35
+
Once you have set up the PrivateGPTApi instance, you can perform various API calls using the pgpt_pythonSDK. Below are examples of common API calls:
36
36
37
37
### 1. **Health Check:**
38
38
@@ -190,7 +190,7 @@ Delete previously ingested documents using their document IDs.
190
190
191
191
## Examples
192
192
193
-
The provided `examples_script.py` showcases various features of the pgpt-python SDK. Feel free to explore and modify this script to suit your specific use cases.
193
+
The provided `examples_script.py` showcases various features of the pgpt_python SDK. Feel free to explore and modify this script to suit your specific use cases.
0 commit comments