/* generated using openapi-typescript-codegen -- do not edit */
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import type { AccessEnum } from './AccessEnum';
import type { CrawlerPatternTypeEnum } from './CrawlerPatternTypeEnum';
export type RetrieverDocumentEmbeddingRequest = {
    /**
     * The name of the document
     */
    document_name?: string;
    /**
     * The type of the document
     */
    document_type?: string;
    /**
     * The pathway to retrain the document in
     */
    pathway: string;
    /**
     * The url of the document
     */
    url?: string;
    /**
     * The type of the document
     */
    train?: boolean | null;
    /**
     * The max depth of the crawler
     */
    crawler_max_depth?: number;
    /**
     * The max pages limit of the crawler
     */
    crawler_max_pages_limit?: number;
    /**
     * The max concurrency of the crawler
     */
    crawler_max_concurrency?: number;
    /**
     * The patterns that the crawler should use to match urls. Patterns may be a glob pattern or a full regex pattern. Indicate the specified type in `crawler_pattern_type`.
     */
    crawler_match_patterns?: Array<string>;
    /**
     * Pattern type for the crawler
     *
     * * `glob` - Glob
     * * `regex` - Regex
     */
    crawler_pattern_type?: CrawlerPatternTypeEnum;
    /**
     * Extra HTTP headers the crawler sends on every request, as a flat object of string header names to string values.
     */
    crawler_extra_headers?: Record<string, string>;
    /**
     * The access of the document.
     *
     * * `public` - Public
     * * `private` - Private
     */
    access?: AccessEnum;
    /**
     * Authentication and scoped details of google drive.
     */
    google_drive_auth_data?: any;
    /**
     * Authentication and scoped details of dropbox
     */
    dropbox_auth_data?: any;
    /**
     * Custom metadata to attach to the trained document. Must be a flat JSON object with string keys and string, number, or boolean values.
     */
    custom_metadata?: any;
};