Skip to content

Commit e710a1e

Browse files
committed
add pipeline-embeddings endpoint
1 parent bd08687 commit e710a1e

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

neurostore-openapi.yml

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,6 +1280,33 @@ paths:
12801280
required: false
12811281
schema:
12821282
type: string
1283+
- name: semantic_search
1284+
in: query
1285+
description: Semantic search query string
1286+
required: false
1287+
schema:
1288+
type: string
1289+
- name: pipeline_config_id
1290+
in: query
1291+
description: Pipeline configuration identifier to filter studies
1292+
required: false
1293+
schema:
1294+
type: string
1295+
- name: distance_threshold
1296+
in: query
1297+
description: Distance threshold for semantic search (default 0.5)
1298+
required: false
1299+
schema:
1300+
type: number
1301+
format: float
1302+
example: 0.5
1303+
- name: overall_cap
1304+
in: query
1305+
description: Maximum number of overall results to return (default 3000)
1306+
required: false
1307+
schema:
1308+
type: integer
1309+
example: 3000
12831310
- name: feature_flatten
12841311
in: query
12851312
required: false
@@ -1470,6 +1497,40 @@ paths:
14701497
$ref: '#/components/schemas/note-collection-request'
14711498
security:
14721499
- JSON-Web-Token: []
1500+
/pipeline-embeddings/:
1501+
get:
1502+
summary: List pipeline embeddings
1503+
tags:
1504+
- pipeline-embeddings
1505+
parameters:
1506+
- $ref: '#/components/parameters/paginate'
1507+
responses:
1508+
'200':
1509+
description: OK
1510+
content:
1511+
application/json:
1512+
schema:
1513+
$ref: '#/components/schemas/pipeline-embedding-list'
1514+
'/pipeline-embeddings/{id}':
1515+
parameters:
1516+
- schema:
1517+
type: string
1518+
name: id
1519+
in: path
1520+
required: true
1521+
get:
1522+
summary: Get a pipeline embedding by id
1523+
tags:
1524+
- pipeline_embeddings
1525+
responses:
1526+
'200':
1527+
description: OK
1528+
content:
1529+
application/json:
1530+
schema:
1531+
$ref: '#/components/schemas/pipeline-embedding'
1532+
'404':
1533+
$ref: '#/components/responses/404'
14731534
components:
14741535
schemas:
14751536
pipeline:
@@ -2465,6 +2526,44 @@ components:
24652526
$ref: '#/components/schemas/base-study-return'
24662527
metadata:
24672528
$ref: '#/components/schemas/metadata'
2529+
pipeline-embedding:
2530+
allOf:
2531+
- $ref: '#/components/schemas/readable-resource-attributes'
2532+
- type: object
2533+
properties:
2534+
config_id:
2535+
type: string
2536+
base_study_id:
2537+
type: string
2538+
nullable: true
2539+
date_executed:
2540+
type: string
2541+
format: date-time
2542+
nullable: true
2543+
file_inputs:
2544+
type: object
2545+
nullable: true
2546+
status:
2547+
type: string
2548+
description: Current status of the pipeline execution (e.g. SUCCESS, FAILURE, ERROR, UNKNOWN)
2549+
embedding:
2550+
type: array
2551+
items:
2552+
type: number
2553+
format: float
2554+
required:
2555+
- config_id
2556+
- status
2557+
- embedding
2558+
pipeline-embedding-list:
2559+
type: object
2560+
properties:
2561+
results:
2562+
type: array
2563+
items:
2564+
$ref: '#/components/schemas/pipeline-embedding'
2565+
metadata:
2566+
$ref: '#/components/schemas/metadata'
24682567
responses:
24692568
'404':
24702569
description: Example response
@@ -2747,3 +2846,4 @@ tags:
27472846
- name: conditions
27482847
- name: user
27492848
- name: annotations
2849+
- name: pipeline_embeddings

0 commit comments

Comments
 (0)