docs: Add docstring for node usage in backend
This commit is contained in:
parent
b9fa285c1a
commit
978815586c
2 changed files with 3 additions and 0 deletions
|
|
@ -42,6 +42,8 @@ def get_add_router() -> APIRouter:
|
|||
- Regular file uploads
|
||||
- **datasetName** (Optional[str]): Name of the dataset to add data to
|
||||
- **datasetId** (Optional[UUID]): UUID of an already existing dataset
|
||||
- **node_set** Optional[list[str]]: List of node identifiers for graph organization and access control.
|
||||
Used for grouping related data points in the knowledge graph.
|
||||
|
||||
Either datasetName or datasetId must be provided.
|
||||
|
||||
|
|
|
|||
|
|
@ -80,6 +80,7 @@ def get_search_router() -> APIRouter:
|
|||
- **datasets** (Optional[List[str]]): List of dataset names to search within
|
||||
- **dataset_ids** (Optional[List[UUID]]): List of dataset UUIDs to search within
|
||||
- **query** (str): The search query string
|
||||
- **node_name** Optional[list[str]]: Filter results to specific node_sets defined in the add pipeline (for targeted search).
|
||||
- **top_k** (Optional[int]): Maximum number of results to return (default: 10)
|
||||
|
||||
## Response
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue