Pipelines - Get multiple

TypeScript

Python

caution

We have limited support for pipeline CRUD operations at this time. We hope to expand this in the future.

Examples

typescript

typescript
import { init, getPipelines } from '@gentrace/core';
 
init({
  apiKey: process.env.GENTRACE_API_KEY,
});
 
const pipelines = await getPipelines({
  label: 'example-label',
  slug: 'example-slug',
});
 
for (const pipeline of pipelines) {
  console.log('Pipeline: ', pipeline.displayName, pipeline.slug);
}

python

python
import gentrace
import os
gentrace.init(
    api_key=os.getenv("GENTRACE_API_KEY")
)
pipelines = gentrace.get_pipelines()
for pipeline in pipelines:
    print(pipeline.get("id"), pipeline.get("displayName"))

typescript

Get the pipelines associated with a given organization (through the supplied API key) using getPipelines(). Filter the pipeline output by certain parameters.

python

Get the pipelines associated with a given organization (through the supplied API key) using get_pipelines(). Filter the pipeline output by certain parameters.

Arguments

typescript

params

This object has the type PipelineParams to filter retrieved pipeline objects by certain parameters.

python

These keyword arguments can be supplied

label?: str

Label for filtering pipelines

slug?: str

Slug for filtering pipelines

Return value

An array of Pipeline objects

Types

typescript

🛠️ `PipelineParams`

The PipelineParams type is used to define parameters related to a pipeline. Here are the properties that can be included in PipelineParams:

label?: string Label for filtering pipelines

slug?: string Slug for filtering pipelines

python

🛠️ `Pipeline`

The Pipeline type represents the structure of a pipeline in TypeScript. Below are the properties that define a Pipeline.

id: string (UUID)

createdAt: string (ISO 8601)

updatedAt: string (ISO 8601)

archivedAt?: string (ISO 8601)

labels: string[]

displayName?: string

slug: string

organizationId: string (UUID)

goldenDatasetId?: string (UUID)

branch?: string The reference branch that the pipeline is associated with.