@vectorize-io/vectorize-client/dist/apis/PipelinesApi.d.ts

Client for the Vectorize API

/**
 * Vectorize API
 * API for Vectorize services (Beta)
 *
 * The version of the OpenAPI document: 0.1.2
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { CreatePipelineResponse, DeletePipelineResponse, GetDeepResearchResponse, GetPipelineEventsResponse, GetPipelineMetricsResponse, GetPipelineResponse, GetPipelinesResponse, PipelineConfigurationSchema, RetrieveDocumentsRequest, RetrieveDocumentsResponse, StartDeepResearchRequest, StartDeepResearchResponse, StartPipelineResponse, StopPipelineResponse } from '../models/index';
export interface CreatePipelineRequest {
    organizationId: string;
    pipelineConfigurationSchema: PipelineConfigurationSchema;
    workspaceId?: string;
}
export interface DeletePipelineRequest {
    organizationId: string;
    pipelineId: string;
}
export interface GetDeepResearchResultRequest {
    organizationId: string;
    pipelineId: string;
    researchId: string;
}
export interface GetPipelineRequest {
    organizationId: string;
    pipelineId: string;
}
export interface GetPipelineEventsRequest {
    organizationId: string;
    pipelineId: string;
    nextToken?: string;
}
export interface GetPipelineMetricsRequest {
    organizationId: string;
    pipelineId: string;
}
export interface GetPipelinesRequest {
    organizationId: string;
    workspaceId?: string;
}
export interface RetrieveDocumentsOperationRequest {
    organizationId: string;
    pipelineId: string;
    retrieveDocumentsRequest: RetrieveDocumentsRequest;
}
export interface StartDeepResearchOperationRequest {
    organizationId: string;
    pipelineId: string;
    startDeepResearchRequest: StartDeepResearchRequest;
}
export interface StartPipelineRequest {
    organizationId: string;
    pipelineId: string;
}
export interface StopPipelineRequest {
    organizationId: string;
    pipelineId: string;
}
/**
 *
 */
export declare class PipelinesApi extends runtime.BaseAPI {
    /**
     * 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
     */
    createPipelineRaw(requestParameters: CreatePipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.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
     */
    createPipeline(requestParameters: CreatePipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatePipelineResponse>;
    /**
     * Delete a pipeline
     * Delete a pipeline
     */
    deletePipelineRaw(requestParameters: DeletePipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletePipelineResponse>>;
    /**
     * Delete a pipeline
     * Delete a pipeline
     */
    deletePipeline(requestParameters: DeletePipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletePipelineResponse>;
    /**
     * Get deep research result
     * Get deep research result
     */
    getDeepResearchResultRaw(requestParameters: GetDeepResearchResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDeepResearchResponse>>;
    /**
     * Get deep research result
     * Get deep research result
     */
    getDeepResearchResult(requestParameters: GetDeepResearchResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDeepResearchResponse>;
    /**
     * Get a pipeline
     * Get a pipeline
     */
    getPipelineRaw(requestParameters: GetPipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPipelineResponse>>;
    /**
     * Get a pipeline
     * Get a pipeline
     */
    getPipeline(requestParameters: GetPipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPipelineResponse>;
    /**
     * Get pipeline events
     * Get pipeline events
     */
    getPipelineEventsRaw(requestParameters: GetPipelineEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPipelineEventsResponse>>;
    /**
     * Get pipeline events
     * Get pipeline events
     */
    getPipelineEvents(requestParameters: GetPipelineEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPipelineEventsResponse>;
    /**
     * Get pipeline metrics
     * Get pipeline metrics
     */
    getPipelineMetricsRaw(requestParameters: GetPipelineMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPipelineMetricsResponse>>;
    /**
     * Get pipeline metrics
     * Get pipeline metrics
     */
    getPipelineMetrics(requestParameters: GetPipelineMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPipelineMetricsResponse>;
    /**
     * Returns a list of all pipelines in the organization
     * Get all pipelines
     */
    getPipelinesRaw(requestParameters: GetPipelinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPipelinesResponse>>;
    /**
     * Returns a list of all pipelines in the organization
     * Get all pipelines
     */
    getPipelines(requestParameters: GetPipelinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPipelinesResponse>;
    /**
     * Retrieve documents from a pipeline
     * Retrieve documents from a pipeline
     */
    retrieveDocumentsRaw(requestParameters: RetrieveDocumentsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetrieveDocumentsResponse>>;
    /**
     * Retrieve documents from a pipeline
     * Retrieve documents from a pipeline
     */
    retrieveDocuments(requestParameters: RetrieveDocumentsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetrieveDocumentsResponse>;
    /**
     * Start a deep research
     * Start a deep research
     */
    startDeepResearchRaw(requestParameters: StartDeepResearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StartDeepResearchResponse>>;
    /**
     * Start a deep research
     * Start a deep research
     */
    startDeepResearch(requestParameters: StartDeepResearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StartDeepResearchResponse>;
    /**
     * Start a pipeline
     * Start a pipeline
     */
    startPipelineRaw(requestParameters: StartPipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StartPipelineResponse>>;
    /**
     * Start a pipeline
     * Start a pipeline
     */
    startPipeline(requestParameters: StartPipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StartPipelineResponse>;
    /**
     * Stop a pipeline
     * Stop a pipeline
     */
    stopPipelineRaw(requestParameters: StopPipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopPipelineResponse>>;
    /**
     * Stop a pipeline
     * Stop a pipeline
     */
    stopPipeline(requestParameters: StopPipelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopPipelineResponse>;
}