@sap-ai-sdk/document-grounding/dist/client/api/metadata-configurations-api.d.ts

> [!warning] > This package is still in **beta** and is subject to breaking changes. Use it with caution.

import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
import type { ListMetadataConfigurations, MetadataConfigurationRequest, MetadataConfigurationResponse, ListConfigurationDocuments, DocumentMetadataBatchRequest, BatchUpdateDocumentsResponse, ConfigurationDocument } from './schema/index.js';
/**
 * Representation of the 'MetadataConfigurationsApi'.
 * This API is part of the 'api' service.
 */
export declare const MetadataConfigurationsApi: {
    _defaultBasePath: string;
    /**
     * List all metadata configurations
     * @param queryParameters - Object containing the following keys: $top, $skip, $count.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    listMetadataConfigurations: (queryParameters?: {
        $top?: number;
        $skip?: number;
        $count?: boolean;
    }) => OpenApiRequestBuilder<ListMetadataConfigurations>;
    /**
     * Creates a new metadata configuration.
     * @param body - Request body.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    createMetadataConfiguration: (body: MetadataConfigurationRequest) => OpenApiRequestBuilder<any>;
    /**
     * Get the details of a configuration by ID
     * @param metadataConfigId - Metadata Configuration ID
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    getMetadataConfigurationById: (metadataConfigId: string) => OpenApiRequestBuilder<MetadataConfigurationResponse>;
    /**
     * Delete a metadata configuration by ID
     * @param metadataConfigId - Metadata Configuration ID
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deleteMetadataConfigurationById: (metadataConfigId: string) => OpenApiRequestBuilder<any>;
    /**
     * List the documents for a configuration
     * @param metadataConfigId - Metadata Configuration ID
     * @param queryParameters - Object containing the following keys: absolutePath, $top, $skip, $count.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    listMetadataConfigurationDocuments: (metadataConfigId: string, queryParameters?: {
        absolutePath?: string;
        $top?: number;
        $skip?: number;
        $count?: boolean;
    }) => OpenApiRequestBuilder<ListConfigurationDocuments>;
    /**
     * Patch the documents of a configuration in batch
     * @param metadataConfigId - Metadata Configuration ID
     * @param body - Request body.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    batchUpdateDocumentsMetadata: (metadataConfigId: string, body: DocumentMetadataBatchRequest) => OpenApiRequestBuilder<BatchUpdateDocumentsResponse>;
    /**
     * Get the details of a document by document id
     * @param metadataConfigId - Metadata Configuration ID
     * @param documentId - Document ID
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    getMetadataDocumentDetails: (metadataConfigId: string, documentId: string) => OpenApiRequestBuilder<ConfigurationDocument>;
};
//# sourceMappingURL=metadata-configurations-api.d.ts.map