@@ -1112,7 +1112,7 @@ Name | Type | Description | Notes
11121112[[ Back to top]] ( # ) [[ Back to API list]] ( ../README.md#documentation-for-api-endpoints ) [[ Back to Model list]] ( ../README.md#documentation-for-models ) [[ Back to README]] ( ../README.md )
11131113
11141114# ** base_studies_get**
1115- > BaseStudyList base_studies_get(feature_filter=feature_filter, feature_config=feature_config , feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
1115+ > BaseStudyList base_studies_get(feature_filter=feature_filter, pipeline_config=pipeline_config , feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
11161116
11171117
11181118
@@ -1147,7 +1147,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11471147 # Create an instance of the API class
11481148 api_instance = neurostore_sdk.StoreApi(api_client)
11491149 feature_filter = [' feature_filter_example' ] # List[str] | Filter studies by feature content. Format: \"PipelineName[:version]:field_path=value\". Examples: - \"TestPipeline:1.0.0:predictions.age_mean>20\" (specific version) - \"TestPipeline:groups.diagnosis=ADHD\" (any version) Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
1150- feature_config = [' feature_config_example ' ] # List[str] | Filter studies by pipeline config content. Format: \"PipelineName[:version]:config_path=value\". Examples: - \"TestPipeline:1.0.0:settings.min_age=20\" (specific version) - \"TestPipeline:model.type=linear\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
1150+ pipeline_config = [' pipeline_config_example ' ] # List[str] | Filter studies by pipeline config content. Format: \"PipelineName[:version]:config_path=value\". Examples: - \"TestPipeline:1.0.0:settings.min_age=20\" (specific version) - \"TestPipeline:model.type=linear\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
11511151 feature_display = ' feature_display_example' # str | display features from pipelines (optional)
11521152 feature_flatten = True # bool | (optional)
11531153 search = ' imagin' # str | search for entries that contain the substring (optional)
@@ -1168,7 +1168,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11681168
11691169 try :
11701170 #
1171- api_response = api_instance.base_studies_get(feature_filter = feature_filter, feature_config = feature_config , feature_display = feature_display, feature_flatten = feature_flatten, search = search, sort = sort, page = page, desc = desc, page_size = page_size, name = name, description = description, authors = authors, level = level, data_type = data_type, publication = publication, pmid = pmid, doi = doi, flat = flat, info = info)
1171+ api_response = api_instance.base_studies_get(feature_filter = feature_filter, pipeline_config = pipeline_config , feature_display = feature_display, feature_flatten = feature_flatten, search = search, sort = sort, page = page, desc = desc, page_size = page_size, name = name, description = description, authors = authors, level = level, data_type = data_type, publication = publication, pmid = pmid, doi = doi, flat = flat, info = info)
11721172 print (" The response of StoreApi->base_studies_get:\n " )
11731173 pprint(api_response)
11741174 except Exception as e:
@@ -1183,7 +1183,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11831183Name | Type | Description | Notes
11841184------------- | ------------- | ------------- | -------------
11851185 ** feature_filter** | [ ** List[ str] ** ] ( str.md ) | Filter studies by feature content. Format: \& quot;PipelineName[ : version ] : field_path = ; value\& quot;. Examples: - \& quot;TestPipeline:1.0.0: predictions .age_mean> ; 20\& quot; (specific version) - \& quot;TestPipeline: groups .diagnosis= ; ADHD\& quot; (any version) Field path supports array notation with [ ] , regex search with ~ , and comparisons with = ; , > ; , < ; , > ; = ; , < ; = ; . | [ optional]
1186- ** feature_config ** | [ ** List[ str] ** ] ( str.md ) | Filter studies by pipeline config content. Format: \& quot;PipelineName[ : version ] : config_path = ; value\& quot;. Examples: - \& quot;TestPipeline:1.0.0: settings .min_age= ; 20\& quot; (specific version) - \& quot;TestPipeline: model .type= ; linear\& quot; (any version) Config path supports array notation with [ ] , regex search with ~ , and comparisons with = ; , > ; , < ; , > ; = ; , < ; = ; . | [ optional]
1186+ ** pipeline_config ** | [ ** List[ str] ** ] ( str.md ) | Filter studies by pipeline config content. Format: \& quot;PipelineName[ : version ] : config_path = ; value\& quot;. Examples: - \& quot;TestPipeline:1.0.0: settings .min_age= ; 20\& quot; (specific version) - \& quot;TestPipeline: model .type= ; linear\& quot; (any version) Config path supports array notation with [ ] , regex search with ~ , and comparisons with = ; , > ; , < ; , > ; = ; , < ; = ; . | [ optional]
11871187 ** feature_display** | ** str** | display features from pipelines | [ optional]
11881188 ** feature_flatten** | ** bool** | | [ optional]
11891189 ** search** | ** str** | search for entries that contain the substring | [ optional]
0 commit comments