Pipeline
Create a pipeline
POST
https://api.forefront.ai/v1/pipelines/create
Create a new pipeline
Request Body
name
String
name of your pipeline
List pipelines
GET
https://api.forefront.ai/v1/pipelines/list
Returns a list of your pipelines
Get a pipeline by id
GET
https://api.forefront.ai/v1/pipelines/:id
Returns a pipeline object by id. Does not return pipeline data, see below for how to do that.
Path Parameters
id
String
id of the pipeline
Add to a pipeline
POST
https://api.forefront.ai/v1/pipelines/:id/add
Add data to a pipeline
Path Parameters
id
String
id of the pipeline
Request Body
messages*
Array
Array of messages in chat-ml format. See datasets page for details on how to format
userId
String
Add a user_id to the sample
groupId
String
Add a group_id to the sample
metadata
Object
Add custom key-value string labels to a sample
Pipeline selections
Pipeline selections allow you to filter data in a pipeline. Pipelines can be filtered by userId, groupId, metadata, as well as limiting and paginating the number of responses.
You can create datasets from pipeline selections, inspect the individual data samples, and get a count of data that meets pipeline selection criteria.
Get data sample for a pipeline selection
POST
https://api.forefront.ai/v1/pipelines/:id/samples
Returns array of data samples for a pipeline that meets filter criteria, if provided. Otherwise returns all data in pipeline. Each returned item contains a signed url that you can use to retrieve the text contents. The SDKs will automatically download the text contents from these urls.
Request Body
limit
Number
Number of samples to return
offset
Number
Return examples after offset value. Used for pagination
userId
String
Filter results by user id
groupId
String
Filter results by group id
metadata
Object
Filter results by data that matches provided metadata
Get count of pipeline selection
POST
https://api.forefront.ai/v1/pipelines/:id/count
Returns count of data samples that match filter criteria if provided, otherwise returns count of all data samples in pipeline
Request Body
limit
Number
Number of samples to return
offset
Number
Return examples after offset value. Used for pagination
userId
String
Filter results by user id
groupId
String
Filter results by group id
metadata
String
Filter results by data that matches provided metadata
Create a dataset from a pipeline selection
POST
https://api.forefront.ai/v1/pipelines/:id/create-dataset
Create a dataset from a pipeline that matches filter criteria, if provided. Otherwise creates a dataset with all data in the pipeline
Request Body
name*
String
Name of dataset
Last updated