cloudflare/resources/ai/to-markdown.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { PagePromise, SinglePage } from "../../core/pagination.js";
import { type Uploadable } from "../../core/uploads.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseToMarkdown extends APIResource {
    static readonly _key: readonly ['ai', 'toMarkdown'];
    /**
     * Lists the file extensions and MIME types accepted by Workers AI's Markdown
     * conversion endpoint. Use this list to check whether a file can be converted
     * before uploading it.
     */
    supported(params: ToMarkdownSupportedParams, options?: RequestOptions): PagePromise<ToMarkdownSupportedResponsesSinglePage, ToMarkdownSupportedResponse>;
    /**
     * Converts files uploaded as multipart form data into Markdown using Workers AI.
     * Returns a conversion result for each file. Use the supported-formats endpoint to
     * check accepted file types.
     */
    transform(params: ToMarkdownTransformParams, options?: RequestOptions): PagePromise<ToMarkdownTransformResponsesSinglePage, ToMarkdownTransformResponse>;
}
export declare class ToMarkdown extends BaseToMarkdown {
}
export type ToMarkdownSupportedResponsesSinglePage = SinglePage<ToMarkdownSupportedResponse>;
export type ToMarkdownTransformResponsesSinglePage = SinglePage<ToMarkdownTransformResponse>;
export interface ToMarkdownSupportedResponse {
    extension: string;
    mimeType: string;
}
export interface ToMarkdownTransformResponse {
    data: string;
    format: string;
    mimeType: string;
    name: string;
    tokens: string;
}
export interface ToMarkdownSupportedParams {
    /**
     * Cloudflare account ID used for this AI model request.
     */
    account_id: string;
}
export interface ToMarkdownTransformParams {
    /**
     * Path param: Cloudflare account ID used for this AI model request.
     */
    account_id: string;
    /**
     * Body param
     */
    file: ToMarkdownTransformParams.File;
}
export declare namespace ToMarkdownTransformParams {
    interface File {
        /**
         * Files to convert, supplied as multipart file uploads.
         */
        files: Array<Uploadable>;
    }
}
export declare namespace ToMarkdown {
    export { type ToMarkdownSupportedResponse as ToMarkdownSupportedResponse, type ToMarkdownTransformResponse as ToMarkdownTransformResponse, type ToMarkdownSupportedResponsesSinglePage as ToMarkdownSupportedResponsesSinglePage, type ToMarkdownTransformResponsesSinglePage as ToMarkdownTransformResponsesSinglePage, type ToMarkdownSupportedParams as ToMarkdownSupportedParams, type ToMarkdownTransformParams as ToMarkdownTransformParams, };
}
//# sourceMappingURL=to-markdown.d.ts.map