nodes/generated

Interface DatabricksNodeParameters

Source


interface DatabricksNodeParameters {
    additionalFields?:
        | {
            overwrite?: boolean;
            pageSize?: number;
            pageToken?: string;
        }
        | { comment?: string; storage_location?: string };
    attachmentId?: string;
    authentication?: "oAuth2" | "accessToken";
    catalogName?: {
        mode: "string" | "list";
        value: string;
    };
    columns?: string;
    columnsToRerank?: string;
    comment?: string;
    conversationId?: string;
    dataFieldName?: string;
    deltaSyncIndexSpec?: string;
    directAccessIndexSpec?: string;
    directoryPath?: string;
    enableReranking?: boolean;
    endpointName?: | string
    | { mode: "list"
    | "url"
    | "name"; value: string };
    filePath?: string;
    fullName?: { mode: "string" | "list"; value: string };
    functionName?: string;
    indexName?: string;
    indexType?: "DELTA_SYNC" | "DIRECT_ACCESS";
    initialMessage?: string;
    inputParams?: string;
    message?: string;
    messageId?: string;
    numResults?: number;
    operation?:
        | "deleteFile"
        | "executeQuery"
        | "createDirectory"
        | "deleteDirectory"
        | "downloadFile"
        | "getFileInfo"
        | "listDirectory"
        | "uploadFile"
        | "createMessage"
        | "executeMessageQuery"
        | "getMessage"
        | "getSpace"
        | "getQueryResults"
        | "startConversation"
        | "createCatalog"
        | "createFunction"
        | "createTable"
        | "createVolume"
        | "deleteCatalog"
        | "deleteFunction"
        | "deleteTable"
        | "deleteVolume"
        | "getCatalog"
        | "getFunction"
        | "getTable"
        | "getVolume"
        | "listCatalogs"
        | "listFunctions"
        | "listTables"
        | "listVolumes"
        | "updateCatalog"
        | "queryEndpoint"
        | "createIndex"
        | "getIndex"
        | "listIndexes"
        | "queryIndex";
    options?: {
        filterExpression?: string;
        scoreThreshold?: number;
    };
    primaryKey?: string;
    query?: string;
    queryParameters?: {
        parameters: {
            name?: string;
            type?: | ""
            | "BOOLEAN"
            | "DATE"
            | "DOUBLE"
            | "FLOAT"
            | "INT"
            | "LONG"
            | "STRING"
            | "TIMESTAMP";
            value?: string;
        }[];
    };
    queryText?: string;
    queryType?: "text"
    | "vector";
    queryVector?: string;
    requestBody?: string;
    rerankerModel?: string;
    resource?:
        | "files"
        | "databricksSql"
        | "genie"
        | "modelServing"
        | "unityCatalog"
        | "vectorSearch";
    returnType?: string;
    routineBody?: string;
    routineDefinition?: string;
    schemaName?: { mode: "string"
    | "list"; value: string };
    searchMode?: "HYBRID" | "ANN";
    spaceId?: string;
    storageLocation?: string;
    tableAdditionalFields?: {
        columns?: string;
        comment?: string;
    };
    tableName?: string;
    volumeName?: string;
    volumePath?: string;
    volumeType?: "MANAGED"
    | "EXTERNAL";
    warehouseId?: {
        mode: "id" | "list" | "url";
        value: string;
    };
}

Properties§

§readonly additionalFields?:
    | {
        overwrite?: boolean;
        pageSize?: number;
        pageToken?: string;
    }
    | { comment?: string; storage_location?: string }

Default: {}

§readonly attachmentId?: string

The ID of the message attachment

§readonly authentication?: "oAuth2" | "accessToken"

Default: "accessToken"

§readonly catalogName?: { ... }

The catalog to use Default: {"mode":"list","value":""}

§readonly columns?: string

Comma-separated list of column names to return in results (e.g., "content,URL,title")

§readonly columnsToRerank?: string

Comma-separated list of columns to use for reranking (e.g., "content,title")

§readonly comment?: string

Optional comment or description

§readonly conversationId?: string

The ID of the conversation

§readonly dataFieldName?: string

Name of the field from input that contains the binary data to be uploaded Default: "data"

§readonly deltaSyncIndexSpec?: string

Specification for the Delta Sync index Default: "{\n "source_table": "catalog.schema.table",\n "pipeline_type": "TRIGGERED",\n "embedding_source_columns": [{\n "name": "text",\n "embedding_model_endpoint_name": "e5-small-v2"\n }],\n "columns_to_sync": ["id", "text"]\n}" Type options: {"rows":8}

§readonly directAccessIndexSpec?: string

Specification for the Direct Access index Default: "{\n "embedding_vector_columns": [{\n "name": "embedding",\n "embedding_dimension": 1536\n }],\n "schema_json": "{}"\n}" Type options: {"rows":6}

§readonly directoryPath?: string

Path to directory within the volume (e.g. "folder1" or "folder1/subfolder"). Do not include leading slash.

§readonly enableReranking?: boolean

Whether to rerank results using a reranker model for improved relevance

§readonly endpointName?: string | { mode: "list" | "url" | "name"; value: string }

The model serving endpoint to query. The input format will be automatically detected from the endpoint schema. The node will fetch the endpoint's OpenAPI schema to determine the correct invocation URL. Default: {"mode":"list","value":""}

§readonly filePath?: string

Path to the file within the volume (e.g. "folder/file.txt" or "file.txt"). Do not include leading slash.

§readonly fullName?: { ... }

The table to access Default: {"mode":"list","value":""}

§readonly functionName?: string

Name of the function to create

§readonly indexName?: string

Name of the vector search index

§readonly indexType?: "DELTA_SYNC" | "DIRECT_ACCESS"

Type of vector search index to create Default: "DELTA_SYNC"

§readonly initialMessage?: string

The initial message to start the conversation Type options: {"rows":4}

§readonly inputParams?: string

Array of input parameters. Each parameter requires name, type_name, and type_text. Default: "[]"

§readonly message?: string

The message to be sent to Genie Space Type options: {"rows":4}

§readonly messageId?: string

The ID of the message

§readonly numResults?: number

Maximum number of results to return Default: 10

§readonly operation?:
    | "deleteFile"
    | "executeQuery"
    | "createDirectory"
    | "deleteDirectory"
    | "downloadFile"
    | "getFileInfo"
    | "listDirectory"
    | "uploadFile"
    | "createMessage"
    | "executeMessageQuery"
    | "getMessage"
    | "getSpace"
    | "getQueryResults"
    | "startConversation"
    | "createCatalog"
    | "createFunction"
    | "createTable"
    | "createVolume"
    | "deleteCatalog"
    | "deleteFunction"
    | "deleteTable"
    | "deleteVolume"
    | "getCatalog"
    | "getFunction"
    | "getTable"
    | "getVolume"
    | "listCatalogs"
    | "listFunctions"
    | "listTables"
    | "listVolumes"
    | "updateCatalog"
    | "queryEndpoint"
    | "createIndex"
    | "getIndex"
    | "listIndexes"
    | "queryIndex"

Default: "listDirectory"

§readonly options?: { ... }

Default: {}

§readonly primaryKey?: string

Primary key column of the index

§readonly query?: string

SQL query to execute Type options: {"editor":"sqlEditor","sqlDialect":"StandardSQL","rows":10,"alwaysOpenEditWindow":false}

§readonly queryParameters?: { ... }

Named parameters for the query. Reference them in your SQL as :name, e.g. WHERE ID = :user_id. Default: {} Type options: {"multipleValues":true}

§readonly queryText?: string

Text to search for (will be automatically converted to embeddings)

§readonly queryType?: "text" | "vector"

Type of query to perform Default: "text"

§readonly queryVector?: string

Vector embeddings to search for similar vectors (array of numbers) Default: "[]"

§readonly requestBody?: string

Request body in JSON format. The node automatically detects the expected format from the endpoint's OpenAPI schema and validates your input at runtime. Default: "{\n "messages": [\n {\n "role": "user",\n "content": "Hello!"\n }\n ]\n}" Type options: {"rows":10}

§readonly rerankerModel?: string

Name of the reranker model to use Default: "databricks_reranker"

§readonly resource?:
    | "files"
    | "databricksSql"
    | "genie"
    | "modelServing"
    | "unityCatalog"
    | "vectorSearch"

Default: "databricksSql"

§readonly returnType?: string

The return type of the function (e.g., STRING, INT, DOUBLE) Default: "STRING"

§readonly routineBody?: string

The language of the function body Default: "SQL"

§readonly routineDefinition?: string

The function body (SQL expression) Type options: {"rows":4}

§readonly schemaName?: { ... }

The schema to use Default: {"mode":"list","value":""}

§readonly searchMode?: "HYBRID" | "ANN"

Search algorithm to use Default: "ANN"

§readonly spaceId?: string

The ID of the Genie space

§readonly storageLocation?: string

External storage root URL for the table. The Create Table API only supports external Delta tables.

§readonly tableAdditionalFields?: { ... }

Default: {}

§readonly tableName?: string

Name of the table to create

§readonly volumeName?: string

Name of the volume

§readonly volumePath?: string

Full path to the volume in format: catalog.schema.volume

§readonly volumeType?: "MANAGED" | "EXTERNAL"

The type of volume to create Default: "MANAGED"

§readonly warehouseId?: { ... }

The SQL warehouse to use Default: {"mode":"list","value":""}