@sap-ai-sdk/document-grounding
Version:
> [!warning] > This package is still in **beta** and is subject to breaking changes. Use it with caution.
59 lines • 2.63 kB
TypeScript
import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
import type { Pipelines, PipelinePostRequst, PipelineId, Pipeline, PipelineStatus } from './schema/index.js';
/**
* Representation of the 'PipelinesApi'.
* This API is part of the 'api' service.
*/
export declare const PipelinesApi: {
_defaultBasePath: string;
/**
* Get all pipelines
* @param queryParameters - Object containing the following keys: $top, $skip, $count.
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
getAllPipelines: (queryParameters: {
$top?: number;
$skip?: number;
$count?: boolean;
}, headerParameters: {
"AI-Resource-Group": string;
}) => OpenApiRequestBuilder<Pipelines>;
/**
* Create a pipeline
* @param body - Request body.
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
createPipeline: (body: PipelinePostRequst, headerParameters: {
"AI-Resource-Group": string;
}) => OpenApiRequestBuilder<PipelineId>;
/**
* Get details of a pipeline by pipeline id
* @param pipelineId - The ID of the pipeline to get.
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
getPipelineById: (pipelineId: string, headerParameters: {
"AI-Resource-Group": string;
}) => OpenApiRequestBuilder<Pipeline>;
/**
* Delete a pipeline by pipeline id
* @param pipelineId - The ID of the pipeline to delete.
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
deletePipelineById: (pipelineId: string, headerParameters: {
"AI-Resource-Group": string;
}) => OpenApiRequestBuilder<any>;
/**
* Get pipeline status by pipeline id
* @param pipelineId - The ID of the pipeline to get status.
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
getPipelineStatus: (pipelineId: string, headerParameters: {
"AI-Resource-Group": string;
}) => OpenApiRequestBuilder<PipelineStatus>;
};
//# sourceMappingURL=pipelines-api.d.ts.map