Class PipelinesApi

Hierarchy (View Summary)

BaseAPI
- PipelinesApi

Constructors

constructor

new PipelinesApi(configuration?: Configuration): PipelinesApi
Parameters
- configuration: Configuration = DefaultConfig
Returns PipelinesApi
Inherited from BaseAPI.constructor
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:97

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

createPipeline

createPipeline(
requestParameters: CreatePipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<CreatePipelineResponse>
Creates a new pipeline with source connectors, destination connector, and AI platform configuration. The specific configuration fields required depend on the connector types selected. Create a new pipeline
Parameters
- requestParameters: CreatePipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<CreatePipelineResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:184

createPipelineRaw

createPipelineRaw(
requestParameters: CreatePipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<CreatePipelineResponse>>
Creates a new pipeline with source connectors, destination connector, and AI platform configuration. The specific configuration fields required depend on the connector types selected. Create a new pipeline
Parameters
- requestParameters: CreatePipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<CreatePipelineResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:136

deletePipeline

deletePipeline(
requestParameters: DeletePipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<DeletePipelineResponse>
Delete a pipeline Delete a pipeline
Parameters
- requestParameters: DeletePipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<DeletePipelineResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:234

deletePipelineRaw

deletePipelineRaw(
requestParameters: DeletePipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<DeletePipelineResponse>>
Delete a pipeline Delete a pipeline
Parameters
- requestParameters: DeletePipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<DeletePipelineResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:193

getDeepResearchResult

getDeepResearchResult(
requestParameters: GetDeepResearchResultRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetDeepResearchResponse>
Get deep research result Get deep research result
Parameters
- requestParameters: GetDeepResearchResultRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetDeepResearchResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:291

getDeepResearchResultRaw

getDeepResearchResultRaw(
requestParameters: GetDeepResearchResultRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetDeepResearchResponse>>
Get deep research result Get deep research result
Parameters
- requestParameters: GetDeepResearchResultRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetDeepResearchResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:243

getPipeline

getPipeline(
requestParameters: GetPipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetPipelineResponse>
Get a pipeline Get a pipeline
Parameters
- requestParameters: GetPipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetPipelineResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:341

getPipelineEvents

getPipelineEvents(
requestParameters: GetPipelineEventsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetPipelineEventsResponse>
Get pipeline events Get pipeline events
Parameters
- requestParameters: GetPipelineEventsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetPipelineEventsResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:395

getPipelineEventsRaw

getPipelineEventsRaw(
requestParameters: GetPipelineEventsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetPipelineEventsResponse>>
Get pipeline events Get pipeline events
Parameters
- requestParameters: GetPipelineEventsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetPipelineEventsResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:350

getPipelineMetrics

getPipelineMetrics(
requestParameters: GetPipelineMetricsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetPipelineMetricsResponse>
Get pipeline metrics Get pipeline metrics
Parameters
- requestParameters: GetPipelineMetricsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetPipelineMetricsResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:445

getPipelineMetricsRaw

getPipelineMetricsRaw(
requestParameters: GetPipelineMetricsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetPipelineMetricsResponse>>
Get pipeline metrics Get pipeline metrics
Parameters
- requestParameters: GetPipelineMetricsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetPipelineMetricsResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:404

getPipelineRaw

getPipelineRaw(
requestParameters: GetPipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetPipelineResponse>>
Get a pipeline Get a pipeline
Parameters
- requestParameters: GetPipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetPipelineResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:300

getPipelines

getPipelines(
requestParameters: GetPipelinesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetPipelinesResponse>
Returns a list of all pipelines in the organization Get all pipelines
Parameters
- requestParameters: GetPipelinesRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetPipelinesResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:492

getPipelinesRaw

getPipelinesRaw(
requestParameters: GetPipelinesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetPipelinesResponse>>
Returns a list of all pipelines in the organization Get all pipelines
Parameters
- requestParameters: GetPipelinesRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetPipelinesResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:454

`Protected`isJsonMime

isJsonMime(mime: string): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:127

`Protected`request

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:134

retrieveDocuments

retrieveDocuments(
requestParameters: RetrieveDocumentsOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<RetrieveDocumentsResponse>
Retrieve documents from a pipeline Retrieve documents from a pipeline
Parameters
- requestParameters: RetrieveDocumentsOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<RetrieveDocumentsResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:552

retrieveDocumentsRaw

retrieveDocumentsRaw(
requestParameters: RetrieveDocumentsOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<RetrieveDocumentsResponse>>
Retrieve documents from a pipeline Retrieve documents from a pipeline
Parameters
- requestParameters: RetrieveDocumentsOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<RetrieveDocumentsResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:501

startDeepResearch

startDeepResearch(
requestParameters: StartDeepResearchOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StartDeepResearchResponse>
Start a deep research Start a deep research
Parameters
- requestParameters: StartDeepResearchOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StartDeepResearchResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:612

startDeepResearchRaw

startDeepResearchRaw(
requestParameters: StartDeepResearchOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StartDeepResearchResponse>>
Start a deep research Start a deep research
Parameters
- requestParameters: StartDeepResearchOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StartDeepResearchResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:561

startPipeline

startPipeline(
requestParameters: StartPipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StartPipelineResponse>
Start a pipeline Start a pipeline
Parameters
- requestParameters: StartPipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StartPipelineResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:662

startPipelineRaw

startPipelineRaw(
requestParameters: StartPipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StartPipelineResponse>>
Start a pipeline Start a pipeline
Parameters
- requestParameters: StartPipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StartPipelineResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:621

stopPipeline

stopPipeline(
requestParameters: StopPipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StopPipelineResponse>
Stop a pipeline Stop a pipeline
Parameters
- requestParameters: StopPipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StopPipelineResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:712

stopPipelineRaw

stopPipelineRaw(
requestParameters: StopPipelineRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StopPipelineResponse>>
Stop a pipeline Stop a pipeline
Parameters
- requestParameters: StopPipelineRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StopPipelineResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/PipelinesApi.ts:671

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:101

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        (context: ResponseContext) => Promise<void | Response>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:112

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        (context: RequestContext) => Promise<void | FetchParams>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:107

Class PipelinesApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PipelinesApi

Properties

Protectedconfiguration

Methods

createPipeline

Parameters

Returns Promise<CreatePipelineResponse>

createPipelineRaw

Parameters

Returns Promise<ApiResponse<CreatePipelineResponse>>

deletePipeline

Parameters

Returns Promise<DeletePipelineResponse>

deletePipelineRaw

Parameters

Returns Promise<ApiResponse<DeletePipelineResponse>>

getDeepResearchResult

Parameters

Returns Promise<GetDeepResearchResponse>

getDeepResearchResultRaw

Parameters

Returns Promise<ApiResponse<GetDeepResearchResponse>>

getPipeline

Parameters

Returns Promise<GetPipelineResponse>

getPipelineEvents

Parameters

Returns Promise<GetPipelineEventsResponse>

getPipelineEventsRaw

Parameters

Returns Promise<ApiResponse<GetPipelineEventsResponse>>

getPipelineMetrics

Parameters

Returns Promise<GetPipelineMetricsResponse>

getPipelineMetricsRaw

Parameters

Returns Promise<ApiResponse<GetPipelineMetricsResponse>>

getPipelineRaw

Parameters

Returns Promise<ApiResponse<GetPipelineResponse>>

getPipelines

Parameters

Returns Promise<GetPipelinesResponse>

getPipelinesRaw

Parameters

Returns Promise<ApiResponse<GetPipelinesResponse>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

retrieveDocuments

Parameters

Returns Promise<RetrieveDocumentsResponse>

retrieveDocumentsRaw

Parameters

Returns Promise<ApiResponse<RetrieveDocumentsResponse>>

startDeepResearch

Parameters

Returns Promise<StartDeepResearchResponse>

startDeepResearchRaw

Parameters

Returns Promise<ApiResponse<StartDeepResearchResponse>>

startPipeline

Parameters

Returns Promise<StartPipelineResponse>

startPipelineRaw

Parameters

Returns Promise<ApiResponse<StartPipelineResponse>>

stopPipeline

`Protected`configuration

`Protected`isJsonMime

`Protected`request