Spaces:
Sleeping
Sleeping
Add doc
Browse files- app.py +1 -1
- documentation.md +25 -0
app.py
CHANGED
|
@@ -11,7 +11,7 @@ from fastapi.middleware.cors import CORSMiddleware
|
|
| 11 |
from pydantic import BaseModel
|
| 12 |
|
| 13 |
app = FastAPI(title="Specification Retriever/Splitter API",
|
| 14 |
-
description=
|
| 15 |
docs_url="/")
|
| 16 |
|
| 17 |
origins = [
|
|
|
|
| 11 |
from pydantic import BaseModel
|
| 12 |
|
| 13 |
app = FastAPI(title="Specification Retriever/Splitter API",
|
| 14 |
+
description=open('documentation.md').read(),
|
| 15 |
docs_url="/")
|
| 16 |
|
| 17 |
origins = [
|
documentation.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# π Specification Splitter API
|
| 2 |
+
|
| 3 |
+
A comprehensive REST API for extracting text, structured or not, specifications from **3GPP** and **ETSI** organizations.
|
| 4 |
+
|
| 5 |
+
### π Key Features
|
| 6 |
+
|
| 7 |
+
* **Text Extraction**: Get all the text of a specification for specific documents
|
| 8 |
+
* **Structured Mode**: Regroup text by their chapters (1, 2, 3.1.1, 4.5.2.3, ...)
|
| 9 |
+
* **Cross-Organization**: This API supports both 3GPP and ETSI specification repositories
|
| 10 |
+
|
| 11 |
+
### π Supported Document Types
|
| 12 |
+
|
| 13 |
+
#### 3GPP Documents
|
| 14 |
+
* **Technical Specifications**:
|
| 15 |
+
- Format: `23.401`, `38.331-16`
|
| 16 |
+
- Official published specifications
|
| 17 |
+
|
| 18 |
+
#### ETSI Documents
|
| 19 |
+
* **Technical Specifications**:
|
| 20 |
+
- Format: `131 102`, `188 008-2`
|
| 21 |
+
- Published ETSI standards
|
| 22 |
+
|
| 23 |
+
### π§ Technical Stack
|
| 24 |
+
|
| 25 |
+
Built with FastAPI, featuring automatic OpenAPI documentation, request validation, and comprehensive error handling.
|