Skip to content

Commit a7f9252

Browse files
1efe6ac282329a40beb897ea122e57c9848d5082
1 parent 0b1e7ca commit a7f9252

File tree

3 files changed

+41
-6
lines changed

3 files changed

+41
-6
lines changed

.openapi-generator/FILES

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,4 @@ setup.cfg
229229
setup.py
230230
test-requirements.txt
231231
test/__init__.py
232-
test/test_pipeline_embedding.py
233-
test/test_pipeline_embedding_list.py
234-
test/test_pipeline_embeddings_api.py
235232
tox.ini

docs/PipelineConfigsApi.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313

1414
# **pipeline_configs_get**
15-
> PipelineConfigList pipeline_configs_get(pipeline=pipeline, paginate=paginate)
15+
> PipelineConfigList pipeline_configs_get(pipeline=pipeline, paginate=paginate, has_embeddings=has_embeddings, embedding_dimensions=embedding_dimensions)
1616
1717
GET a list of pipeline configs
1818

@@ -38,10 +38,12 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
3838
api_instance = neurostore_sdk.PipelineConfigsApi(api_client)
3939
pipeline = ['pipeline_example'] # List[str] | Filter configs by pipeline name (optional)
4040
paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
41+
has_embeddings = True # bool | Filter configs as whether they have embeddings saved. (optional)
42+
embedding_dimensions = 56 # int | Filter configs by number of dimensions in the embeddings. (optional)
4143

4244
try:
4345
# GET a list of pipeline configs
44-
api_response = api_instance.pipeline_configs_get(pipeline=pipeline, paginate=paginate)
46+
api_response = api_instance.pipeline_configs_get(pipeline=pipeline, paginate=paginate, has_embeddings=has_embeddings, embedding_dimensions=embedding_dimensions)
4547
print("The response of PipelineConfigsApi->pipeline_configs_get:\n")
4648
pprint(api_response)
4749
except Exception as e:
@@ -57,6 +59,8 @@ Name | Type | Description | Notes
5759
------------- | ------------- | ------------- | -------------
5860
**pipeline** | [**List[str]**](str.md)| Filter configs by pipeline name | [optional]
5961
**paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
62+
**has_embeddings** | **bool**| Filter configs as whether they have embeddings saved. | [optional]
63+
**embedding_dimensions** | **int**| Filter configs by number of dimensions in the embeddings. | [optional]
6064

6165
### Return type
6266

neurostore_sdk/api/pipeline_configs_api.py

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from typing import Any, Dict, List, Optional, Tuple, Union
1818
from typing_extensions import Annotated
1919

20-
from pydantic import Field, StrictBool, StrictStr
20+
from pydantic import Field, StrictBool, StrictInt, StrictStr
2121
from typing import List, Optional
2222
from typing_extensions import Annotated
2323
from neurostore_sdk.models.pipeline_config import PipelineConfig
@@ -46,6 +46,8 @@ def pipeline_configs_get(
4646
self,
4747
pipeline: Annotated[Optional[List[StrictStr]], Field(description="Filter configs by pipeline name")] = None,
4848
paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
49+
has_embeddings: Annotated[Optional[StrictBool], Field(description="Filter configs as whether they have embeddings saved.")] = None,
50+
embedding_dimensions: Annotated[Optional[StrictInt], Field(description="Filter configs by number of dimensions in the embeddings.")] = None,
4951
_request_timeout: Union[
5052
None,
5153
Annotated[StrictFloat, Field(gt=0)],
@@ -66,6 +68,10 @@ def pipeline_configs_get(
6668
:type pipeline: List[str]
6769
:param paginate: whether to paginate results (true) or return all results at once (false)
6870
:type paginate: bool
71+
:param has_embeddings: Filter configs as whether they have embeddings saved.
72+
:type has_embeddings: bool
73+
:param embedding_dimensions: Filter configs by number of dimensions in the embeddings.
74+
:type embedding_dimensions: int
6975
:param _request_timeout: timeout setting for this request. If one
7076
number provided, it will be total request
7177
timeout. It can also be a pair (tuple) of
@@ -91,6 +97,8 @@ def pipeline_configs_get(
9197
_param = self._pipeline_configs_get_serialize(
9298
pipeline=pipeline,
9399
paginate=paginate,
100+
has_embeddings=has_embeddings,
101+
embedding_dimensions=embedding_dimensions,
94102
_request_auth=_request_auth,
95103
_content_type=_content_type,
96104
_headers=_headers,
@@ -116,6 +124,8 @@ def pipeline_configs_get_with_http_info(
116124
self,
117125
pipeline: Annotated[Optional[List[StrictStr]], Field(description="Filter configs by pipeline name")] = None,
118126
paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
127+
has_embeddings: Annotated[Optional[StrictBool], Field(description="Filter configs as whether they have embeddings saved.")] = None,
128+
embedding_dimensions: Annotated[Optional[StrictInt], Field(description="Filter configs by number of dimensions in the embeddings.")] = None,
119129
_request_timeout: Union[
120130
None,
121131
Annotated[StrictFloat, Field(gt=0)],
@@ -136,6 +146,10 @@ def pipeline_configs_get_with_http_info(
136146
:type pipeline: List[str]
137147
:param paginate: whether to paginate results (true) or return all results at once (false)
138148
:type paginate: bool
149+
:param has_embeddings: Filter configs as whether they have embeddings saved.
150+
:type has_embeddings: bool
151+
:param embedding_dimensions: Filter configs by number of dimensions in the embeddings.
152+
:type embedding_dimensions: int
139153
:param _request_timeout: timeout setting for this request. If one
140154
number provided, it will be total request
141155
timeout. It can also be a pair (tuple) of
@@ -161,6 +175,8 @@ def pipeline_configs_get_with_http_info(
161175
_param = self._pipeline_configs_get_serialize(
162176
pipeline=pipeline,
163177
paginate=paginate,
178+
has_embeddings=has_embeddings,
179+
embedding_dimensions=embedding_dimensions,
164180
_request_auth=_request_auth,
165181
_content_type=_content_type,
166182
_headers=_headers,
@@ -186,6 +202,8 @@ def pipeline_configs_get_without_preload_content(
186202
self,
187203
pipeline: Annotated[Optional[List[StrictStr]], Field(description="Filter configs by pipeline name")] = None,
188204
paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
205+
has_embeddings: Annotated[Optional[StrictBool], Field(description="Filter configs as whether they have embeddings saved.")] = None,
206+
embedding_dimensions: Annotated[Optional[StrictInt], Field(description="Filter configs by number of dimensions in the embeddings.")] = None,
189207
_request_timeout: Union[
190208
None,
191209
Annotated[StrictFloat, Field(gt=0)],
@@ -206,6 +224,10 @@ def pipeline_configs_get_without_preload_content(
206224
:type pipeline: List[str]
207225
:param paginate: whether to paginate results (true) or return all results at once (false)
208226
:type paginate: bool
227+
:param has_embeddings: Filter configs as whether they have embeddings saved.
228+
:type has_embeddings: bool
229+
:param embedding_dimensions: Filter configs by number of dimensions in the embeddings.
230+
:type embedding_dimensions: int
209231
:param _request_timeout: timeout setting for this request. If one
210232
number provided, it will be total request
211233
timeout. It can also be a pair (tuple) of
@@ -231,6 +253,8 @@ def pipeline_configs_get_without_preload_content(
231253
_param = self._pipeline_configs_get_serialize(
232254
pipeline=pipeline,
233255
paginate=paginate,
256+
has_embeddings=has_embeddings,
257+
embedding_dimensions=embedding_dimensions,
234258
_request_auth=_request_auth,
235259
_content_type=_content_type,
236260
_headers=_headers,
@@ -251,6 +275,8 @@ def _pipeline_configs_get_serialize(
251275
self,
252276
pipeline,
253277
paginate,
278+
has_embeddings,
279+
embedding_dimensions,
254280
_request_auth,
255281
_content_type,
256282
_headers,
@@ -282,6 +308,14 @@ def _pipeline_configs_get_serialize(
282308

283309
_query_params.append(('paginate', paginate))
284310

311+
if has_embeddings is not None:
312+
313+
_query_params.append(('has_embeddings', has_embeddings))
314+
315+
if embedding_dimensions is not None:
316+
317+
_query_params.append(('embedding_dimensions', embedding_dimensions))
318+
285319
# process the header parameters
286320
# process the form parameters
287321
# process the body parameter

0 commit comments

Comments
 (0)