import { Temporal } from "@js-temporal/polyfill"; import { z } from "zod"; //#region src/v1/model.d.ts declare const ColumnTypeName: { readonly BOOLEAN: "BOOLEAN"; readonly BYTE: "BYTE"; readonly SHORT: "SHORT"; readonly INT: "INT"; readonly LONG: "LONG"; readonly FLOAT: "FLOAT"; readonly DOUBLE: "DOUBLE"; readonly DATE: "DATE"; readonly TIMESTAMP: "TIMESTAMP"; readonly STRING: "STRING"; readonly BINARY: "BINARY"; readonly DECIMAL: "DECIMAL"; readonly INTERVAL: "INTERVAL"; readonly ARRAY: "ARRAY"; readonly STRUCT: "STRUCT"; readonly MAP: "MAP"; readonly CHAR: "CHAR"; readonly NULL: "NULL"; readonly USER_DEFINED_TYPE: "USER_DEFINED_TYPE"; readonly TIMESTAMP_NTZ: "TIMESTAMP_NTZ"; readonly VARIANT: "VARIANT"; readonly GEOMETRY: "GEOMETRY"; readonly GEOGRAPHY: "GEOGRAPHY"; readonly TABLE_TYPE: "TABLE_TYPE"; }; type ColumnTypeName = (typeof ColumnTypeName)[keyof typeof ColumnTypeName] | (string & {}); /** Error codes returned by Databricks APIs to indicate specific failure conditions. */ declare const ErrorCode: { /** * Unknown error. This error generally should not be returned explicitly, but will be used * as a fallback if the error enum is missing from the message for some reason. * * It's assigned tag 0 to follow the best practice from * https://developers.google.com/protocol-buffers/docs/style#enums * * TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings. * Maps to: * - google.rpc.Code: UNKNOWN = 2; * - HTTP code: 500 Internal Server Error */ readonly UNKNOWN: "UNKNOWN"; /** * Internal error. This means that some invariants expected by the underlying system have been * broken. This error code is reserved for serious errors, which generally cannot be resolved * by the user. * * Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some * automation that relies on the custom error code. * * Maps to: * - google.rpc.Code: INTERNAL = 13; * - HTTP code: 500 Internal Server Error */ readonly INTERNAL_ERROR: "INTERNAL_ERROR"; /** * The service is currently unavailable. This is most likely a transient condition, which can be * corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent * operations. * * Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE. * * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit# * for guideline on how to pick this vs RESOURCE_EXHAUSTED. * * Maps to: * - google.rpc.Code: UNAVAILABLE = 14; * - HTTP code: 503 Service Unavailable */ readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. * Indicates that an IOException has been internally thrown. */ readonly IO_ERROR: "IO_ERROR"; /** * The request is invalid. Prefer more specific error code whenever possible. * Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION. * * Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR. * * Maps to: * - google.rpc.Code: FAILED_PRECONDITION = 9; * - HTTP code: 400 Bad Request */ readonly BAD_REQUEST: "BAD_REQUEST"; /** * An external service is unavailable temporarily as it is being updated/re-deployed. Indicates * gateway proxy to safely retry the request. */ readonly SERVICE_UNDER_MAINTENANCE: "SERVICE_UNDER_MAINTENANCE"; /** A workspace is temporarily unavailable as the workspace is being re-assigned. */ readonly WORKSPACE_TEMPORARILY_UNAVAILABLE: "WORKSPACE_TEMPORARILY_UNAVAILABLE"; /** * The deadline expired before the operation could complete. For operations that change the state * of the system, this error may be returned even if the operation has completed successfully. * For example, a successful response from a server could have been delayed long enough for * the deadline to expire. When possible - implementations should make sure further processing of * the request is aborted, e.g. by throwing an exception instead of making the RPC request, * making the database query, etc. * * Maps to: * - google.rpc.Code: DEADLINE_EXCEEDED = 4; * - HTTP code: 504 Gateway Timeout */ readonly DEADLINE_EXCEEDED: "DEADLINE_EXCEEDED"; /** * The operation was canceled by the caller. An example - client closed the connection without * waiting for a response. * * Maps to: * - google.rpc.Code: CANCELLED = 1; * - HTTP code: 499 Client Closed Request */ readonly CANCELLED: "CANCELLED"; /** * The operation is rejected because of either rate limiting or resource quota, * such as the client has sent too many requests recently or the client has allocated too many * resources. * * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit# * for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE. * * Maps to: * - google.rpc.Code: RESOURCE_EXHAUSTED = 8; * - HTTP code: 429 Too Many Requests */ readonly RESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED"; /** * The operation was aborted, typically due to a concurrency issue such as a sequencer * check failure, transaction abort, or transaction conflict. * * Maps to: * - google.rpc.Code: ABORTED = 10; * - HTTP code: 409 Conflict */ readonly ABORTED: "ABORTED"; /** * Operation was performed on a resource that does not exist, * e.g. file or directory was not found. * * Maps to: * - google.rpc.Code: NOT_FOUND = 5; * - HTTP code: 404 Not Found */ readonly NOT_FOUND: "NOT_FOUND"; /** * Operation was rejected due a conflict with an existing resource, e.g. attempted to create * file or directory that already exists. * * Prefer this over RESOURCE_CONFLICT. * * Maps to: * - google.rpc.Code: ALREADY_EXISTS = 6; * - HTTP code: 409 Conflict */ readonly ALREADY_EXISTS: "ALREADY_EXISTS"; /** * The request does not have valid authentication (AuthN) credentials for the operation. * * Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy * code. * For authorization (AuthZ) errors use PERMISSION_DENIED. * * Maps to: * - google.rpc.Code: UNAUTHENTICATED = 16; * - HTTP code: 401 Unauthorized */ readonly UNAUTHENTICATED: "UNAUTHENTICATED"; /** * The service is currently unavailable. Please note that the unavailability may or may not be transient. * That means if this is a non-transient condition, retrying it does not work. If the unavailability * is certainly a transient condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient * nature explicitly. * An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does * not know whether it is because the domain name is completely wrong (non-transient situation) or * the domain name is valid but the DNS server does not have an entry for this domain name yet (transient * situation). Hence, `UNAVAILABLE` is suitable for this case. * * Maps to: * - google.rpc.Code: UNAVAILABLE = 14; * - HTTP code: 503 Service Unavailable */ readonly UNAVAILABLE: "UNAVAILABLE"; /** * Supplied value for a parameter was invalid (e.g., giving a number for a string parameter). * * Maps to: * - google.rpc.Code: INVALID_ARGUMENT = 3; * - HTTP code: 400 Bad Request */ readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE"; /** * Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED * should be used instead to indicate that API doesn't exist. * * Maps to: * - google.rpc.Code: NOT_FOUND = 5; * - HTTP code: 404 Not Found */ readonly ENDPOINT_NOT_FOUND: "ENDPOINT_NOT_FOUND"; /** Indicates that the given API request was malformed. */ readonly MALFORMED_REQUEST: "MALFORMED_REQUEST"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. * If one or more of the inputs to a given RPC are not in a valid state for the action. */ readonly INVALID_STATE: "INVALID_STATE"; /** * The caller does not have permission to execute the specified operation. * PERMISSION_DENIED must not be used for rejections caused by exhausting some resource, * use RESOURCE_EXHAUSTED instead for those errors. * PERMISSION_DENIED must not be used if the caller can not be identified, * use CUSTOMER_UNAUTHORIZED instead for those errors. * This error code does not imply the request is valid or the requested entity exists or * satisfies other pre-conditions. * * Maps to: * - google.rpc.Code: PERMISSION_DENIED = 7; * - HTTP code: 403 Forbidden */ readonly PERMISSION_DENIED: "PERMISSION_DENIED"; /** * NOTE: Deprecated due to inconsistent mapping in legacy code, see * https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA. * Prefer using NOT_FOUND or PERMISSION_DENIED. * * If a given user/entity is trying to use a feature which has been disabled. * * Maps to: * - google.rpc.Code: NOT_FOUND = 5; * - HTTP code: 404 Not Found */ readonly FEATURE_DISABLED: "FEATURE_DISABLED"; /** * The request does not have valid authentication (AuthN) credentials for the operation. * * For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep * consistent behavior with legacy code. * For authorization (AuthZ) errors use PERMISSION_DENIED. * * Important: name is confusing, this error code is for authentication (AuthN) errors, not * authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing * naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code * indicates that the request has not been applied because it lacks valid authentication * credentials for the target resource. [...] If the request included authentication credentials, * then the 401 response indicates that authorization has been refused for those credentials." * * Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well. * * Maps to: * - google.rpc.Code: UNAUTHENTICATED = 16; * - HTTP code: 401 Unauthorized */ readonly CUSTOMER_UNAUTHORIZED: "CUSTOMER_UNAUTHORIZED"; /** * The operation is rejected because of request rate limit, for example rate limiting applied to * users, workspaces, IP addresses, etc. * * Prefer a more generic RESOURCE_EXHAUSTED for the new use cases. * * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit# * for guideline on the rate limiting vs throttling. * * Maps to: * - google.rpc.Code: RESOURCE_EXHAUSTED = 8; * - HTTP code: 429 Too Many Requests */ readonly REQUEST_LIMIT_EXCEEDED: "REQUEST_LIMIT_EXCEEDED"; /** Indicates API request was rejected due a conflict with an existing resource. */ readonly RESOURCE_CONFLICT: "RESOURCE_CONFLICT"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. * Indicates that the HTTP response cannot be correctly deserialized. * This currently is only used in DUST test clients, and not by any real service code. */ readonly UNPARSEABLE_HTTP_ERROR: "UNPARSEABLE_HTTP_ERROR"; /** * The operation is not implemented or is not supported/enabled in this service. * * Maps to: * - google.rpc.Code: UNIMPLEMENTED = 12; * - HTTP code: 501 Not Implemented */ readonly NOT_IMPLEMENTED: "NOT_IMPLEMENTED"; /** * Unrecoverable data loss or corruption. * * One of the major use cases is to indicate that server failed to validate the integrity of * the request. This error can occur when the checksum specified in the `X-Databricks-Checksum` * request header (or trailer) doesn't match the actual request content checksum. * * Note, in case of the severe corruption that results in a malformed request, the server may * send a generic `400 Bad Request` response rather than sending this error code. * * Maps to: * - google.rpc.Code: DATA_LOSS = 15; * - HTTP code: 500 Internal Server Error */ readonly DATA_LOSS: "DATA_LOSS"; /** If the user attempts to perform an invalid state transition on a shard. */ readonly INVALID_STATE_TRANSITION: "INVALID_STATE_TRANSITION"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. * Unable to perform the operation because the shard was locked by some other operation. */ readonly COULD_NOT_ACQUIRE_LOCK: "COULD_NOT_ACQUIRE_LOCK"; /** * NOTE: Deprecated, prefer using ALREADY_EXISTS. * Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons, * remapping will be a backwards incompatible change. * * Operation was performed on a resource that already exists. */ readonly RESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS"; /** * NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS, * because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP * codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead. * * Operation was performed on a resource that does not exist. */ readonly RESOURCE_DOES_NOT_EXIST: "RESOURCE_DOES_NOT_EXIST"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly MAX_BLOCK_SIZE_EXCEEDED: "MAX_BLOCK_SIZE_EXCEEDED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly MAX_READ_SIZE_EXCEEDED: "MAX_READ_SIZE_EXCEEDED"; readonly PARTIAL_DELETE: "PARTIAL_DELETE"; readonly MAX_LIST_SIZE_EXCEEDED: "MAX_LIST_SIZE_EXCEEDED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly DRY_RUN_FAILED: "DRY_RUN_FAILED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. * Cluster request was rejected because it would exceed a resource limit. */ readonly RESOURCE_LIMIT_EXCEEDED: "RESOURCE_LIMIT_EXCEEDED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly DIRECTORY_NOT_EMPTY: "DIRECTORY_NOT_EMPTY"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly DIRECTORY_PROTECTED: "DIRECTORY_PROTECTED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly MAX_NOTEBOOK_SIZE_EXCEEDED: "MAX_NOTEBOOK_SIZE_EXCEEDED"; readonly MAX_CHILD_NODE_SIZE_EXCEEDED: "MAX_CHILD_NODE_SIZE_EXCEEDED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly SEARCH_QUERY_TOO_LONG: "SEARCH_QUERY_TOO_LONG"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly SEARCH_QUERY_TOO_SHORT: "SEARCH_QUERY_TOO_SHORT"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly PERMISSION_NOT_PROPAGATED: "PERMISSION_NOT_PROPAGATED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly DEPLOYMENT_TIMEOUT: "DEPLOYMENT_TIMEOUT"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly GIT_CONFLICT: "GIT_CONFLICT"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly GIT_UNKNOWN_REF: "GIT_UNKNOWN_REF"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly GIT_SENSITIVE_TOKEN_DETECTED: "GIT_SENSITIVE_TOKEN_DETECTED"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly GIT_URL_NOT_ON_ALLOW_LIST: "GIT_URL_NOT_ON_ALLOW_LIST"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly GIT_REMOTE_ERROR: "GIT_REMOTE_ERROR"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly PROJECTS_OPERATION_TIMEOUT: "PROJECTS_OPERATION_TIMEOUT"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly IPYNB_FILE_IN_REPO: "IPYNB_FILE_IN_REPO"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly INSECURE_PARTNER_RESPONSE: "INSECURE_PARTNER_RESPONSE"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly MALFORMED_PARTNER_RESPONSE: "MALFORMED_PARTNER_RESPONSE"; readonly METASTORE_DOES_NOT_EXIST: "METASTORE_DOES_NOT_EXIST"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly DAC_DOES_NOT_EXIST: "DAC_DOES_NOT_EXIST"; readonly CATALOG_DOES_NOT_EXIST: "CATALOG_DOES_NOT_EXIST"; readonly SCHEMA_DOES_NOT_EXIST: "SCHEMA_DOES_NOT_EXIST"; readonly TABLE_DOES_NOT_EXIST: "TABLE_DOES_NOT_EXIST"; readonly SHARE_DOES_NOT_EXIST: "SHARE_DOES_NOT_EXIST"; readonly RECIPIENT_DOES_NOT_EXIST: "RECIPIENT_DOES_NOT_EXIST"; readonly STORAGE_CREDENTIAL_DOES_NOT_EXIST: "STORAGE_CREDENTIAL_DOES_NOT_EXIST"; readonly EXTERNAL_LOCATION_DOES_NOT_EXIST: "EXTERNAL_LOCATION_DOES_NOT_EXIST"; readonly PRINCIPAL_DOES_NOT_EXIST: "PRINCIPAL_DOES_NOT_EXIST"; readonly PROVIDER_DOES_NOT_EXIST: "PROVIDER_DOES_NOT_EXIST"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly METASTORE_ALREADY_EXISTS: "METASTORE_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly DAC_ALREADY_EXISTS: "DAC_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly CATALOG_ALREADY_EXISTS: "CATALOG_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly SCHEMA_ALREADY_EXISTS: "SCHEMA_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly TABLE_ALREADY_EXISTS: "TABLE_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly SHARE_ALREADY_EXISTS: "SHARE_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly RECIPIENT_ALREADY_EXISTS: "RECIPIENT_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly STORAGE_CREDENTIAL_ALREADY_EXISTS: "STORAGE_CREDENTIAL_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly EXTERNAL_LOCATION_ALREADY_EXISTS: "EXTERNAL_LOCATION_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly PROVIDER_ALREADY_EXISTS: "PROVIDER_ALREADY_EXISTS"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly CATALOG_NOT_EMPTY: "CATALOG_NOT_EMPTY"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly SCHEMA_NOT_EMPTY: "SCHEMA_NOT_EMPTY"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly METASTORE_NOT_EMPTY: "METASTORE_NOT_EMPTY"; /** * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it, * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes. */ readonly PROVIDER_SHARE_NOT_ACCESSIBLE: "PROVIDER_SHARE_NOT_ACCESSIBLE"; }; type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode] | (string & {}); declare const EvaluationStatusType: { readonly EVALUATION_STATUS_TYPE_UNSPECIFIED: "EVALUATION_STATUS_TYPE_UNSPECIFIED"; readonly RUNNING: "RUNNING"; readonly DONE: "DONE"; readonly NOT_STARTED: "NOT_STARTED"; readonly EVALUATION_FAILED: "EVALUATION_FAILED"; readonly EVALUATION_CANCELLED: "EVALUATION_CANCELLED"; readonly EVALUATION_TIMEOUT: "EVALUATION_TIMEOUT"; }; type EvaluationStatusType = (typeof EvaluationStatusType)[keyof typeof EvaluationStatusType] | (string & {}); declare const Format: { readonly FORMAT_UNSPECIFIED: "FORMAT_UNSPECIFIED"; readonly JSON_ARRAY: "JSON_ARRAY"; readonly ARROW_STREAM: "ARROW_STREAM"; readonly CSV: "CSV"; }; type Format = (typeof Format)[keyof typeof Format] | (string & {}); /** * The type of a Genie conversation. Distinguishes an agent-mode conversation from * a classic chat conversation so callers can route message retrieval accordingly * without a per-conversation lookup. */ declare const GenieConversationType: { /** Default value, returned when the conversation type is unset or not recognized. */readonly GENIE_CONVERSATION_TYPE_UNSPECIFIED: "GENIE_CONVERSATION_TYPE_UNSPECIFIED"; /** A classic Genie chat conversation. */ readonly GENIE_CONVERSATION_TYPE_CHAT: "GENIE_CONVERSATION_TYPE_CHAT"; /** An agent-mode conversation. */ readonly GENIE_CONVERSATION_TYPE_AGENT: "GENIE_CONVERSATION_TYPE_AGENT"; }; type GenieConversationType = (typeof GenieConversationType)[keyof typeof GenieConversationType] | (string & {}); declare const GenieEvalAssessment: { readonly GENIE_EVAL_ASSESSMENT_UNSPECIFIED: "GENIE_EVAL_ASSESSMENT_UNSPECIFIED"; readonly GOOD: "GOOD"; readonly BAD: "BAD"; readonly NEEDS_REVIEW: "NEEDS_REVIEW"; }; type GenieEvalAssessment = (typeof GenieEvalAssessment)[keyof typeof GenieEvalAssessment] | (string & {}); declare const GenieEvalResponseType: { readonly GENIE_EVAL_RESPONSE_TYPE_UNSPECIFIED: "GENIE_EVAL_RESPONSE_TYPE_UNSPECIFIED"; readonly TEXT: "TEXT"; readonly SQL: "SQL"; }; type GenieEvalResponseType = (typeof GenieEvalResponseType)[keyof typeof GenieEvalResponseType] | (string & {}); /** Feedback rating for Genie messages */ declare const GenieFeedbackRating: { readonly GENIE_FEEDBACK_RATING_UNSPECIFIED: "GENIE_FEEDBACK_RATING_UNSPECIFIED"; readonly POSITIVE: "POSITIVE"; readonly NEGATIVE: "NEGATIVE"; readonly NONE: "NONE"; }; type GenieFeedbackRating = (typeof GenieFeedbackRating)[keyof typeof GenieFeedbackRating] | (string & {}); /** * copied from proto3 / Google Well Known Types, source: * https://github.com/protocolbuffers/protobuf/blob/450d24ca820750c5db5112a6f0b0c2efb9758021/src/google/protobuf/struct.proto * `NullValue` is a singleton enumeration to represent the null value for the * `Value` type union. * * The JSON representation for `NullValue` is JSON `null`. */ declare const NullValue: { /** Null value. */readonly NULL_VALUE: "NULL_VALUE"; }; type NullValue = (typeof NullValue)[keyof typeof NullValue] | (string & {}); declare const ScoreReason: { readonly SCORE_REASON_UNSPECIFIED: "SCORE_REASON_UNSPECIFIED"; readonly EMPTY_RESULT: "EMPTY_RESULT"; readonly RESULT_MISSING_ROWS: "RESULT_MISSING_ROWS"; readonly RESULT_EXTRA_ROWS: "RESULT_EXTRA_ROWS"; readonly RESULT_MISSING_COLUMNS: "RESULT_MISSING_COLUMNS"; readonly RESULT_EXTRA_COLUMNS: "RESULT_EXTRA_COLUMNS"; readonly SINGLE_CELL_DIFFERENCE: "SINGLE_CELL_DIFFERENCE"; readonly EMPTY_GOOD_SQL: "EMPTY_GOOD_SQL"; readonly COLUMN_TYPE_DIFFERENCE: "COLUMN_TYPE_DIFFERENCE"; /** Deprecated LLM Judge error categories - kept for backward compatibility */ readonly LLM_JUDGE_MISSING_JOIN: "LLM_JUDGE_MISSING_JOIN"; readonly LLM_JUDGE_WRONG_FILTER: "LLM_JUDGE_WRONG_FILTER"; readonly LLM_JUDGE_WRONG_AGGREGATION: "LLM_JUDGE_WRONG_AGGREGATION"; readonly LLM_JUDGE_WRONG_COLUMNS: "LLM_JUDGE_WRONG_COLUMNS"; readonly LLM_JUDGE_SYNTAX_ERROR: "LLM_JUDGE_SYNTAX_ERROR"; readonly LLM_JUDGE_SEMANTIC_ERROR: "LLM_JUDGE_SEMANTIC_ERROR"; /** New LLM Judge error categories - aligned with LlmJudgeFunctionSpec */ readonly LLM_JUDGE_OTHER: "LLM_JUDGE_OTHER"; readonly LLM_JUDGE_MISSING_OR_INCORRECT_FILTER: "LLM_JUDGE_MISSING_OR_INCORRECT_FILTER"; readonly LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT: "LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT"; readonly LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST: "LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST"; readonly LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC: "LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC"; readonly LLM_JUDGE_INCORRECT_METRIC_CALCULATION: "LLM_JUDGE_INCORRECT_METRIC_CALCULATION"; readonly LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE: "LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE"; readonly LLM_JUDGE_INCORRECT_FUNCTION_USAGE: "LLM_JUDGE_INCORRECT_FUNCTION_USAGE"; readonly LLM_JUDGE_MISSING_OR_INCORRECT_JOIN: "LLM_JUDGE_MISSING_OR_INCORRECT_JOIN"; readonly LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION: "LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION"; readonly LLM_JUDGE_FORMATTING_ERROR: "LLM_JUDGE_FORMATTING_ERROR"; }; type ScoreReason = (typeof ScoreReason)[keyof typeof ScoreReason] | (string & {}); /** Purpose/intent of a text attachment */ declare const TextAttachmentPurpose: { /** Default value. Returned when the text attachment purpose is not set. */readonly TEXT_ATTACHMENT_PURPOSE_UNSPECIFIED: "TEXT_ATTACHMENT_PURPOSE_UNSPECIFIED"; /** A clarifying question Genie asks back to the user, not the answer. */ readonly FOLLOW_UP_QUESTION: "FOLLOW_UP_QUESTION"; /** * The final answer / summary for the message. Consumers reading the Get * Message API can use this to identify which text attachment holds the answer. */ readonly TEXT_ATTACHMENT_PURPOSE_ANSWER: "TEXT_ATTACHMENT_PURPOSE_ANSWER"; }; type TextAttachmentPurpose = (typeof TextAttachmentPurpose)[keyof typeof TextAttachmentPurpose] | (string & {}); /** * ThoughtType. * The possible values are: * * `THOUGHT_TYPE_UNSPECIFIED`: Default value that should not be used. * * `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the question was interpreted. * * `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question were resolved. * * `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were identified as relevant. * * `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were referenced. * * `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer. * The category of a Thought. * Additional values may be added in the future. */ declare const ThoughtType: { readonly THOUGHT_TYPE_UNSPECIFIED: "THOUGHT_TYPE_UNSPECIFIED"; /** A high-level description of how the question was interpreted. */ readonly THOUGHT_TYPE_DESCRIPTION: "THOUGHT_TYPE_DESCRIPTION"; /** How ambiguous parts of the question were resolved. */ readonly THOUGHT_TYPE_UNDERSTANDING: "THOUGHT_TYPE_UNDERSTANDING"; /** Which tables or datasets were identified as relevant. */ readonly THOUGHT_TYPE_DATA_SOURCING: "THOUGHT_TYPE_DATA_SOURCING"; /** Which author-defined instructions were referenced. */ readonly THOUGHT_TYPE_INSTRUCTIONS: "THOUGHT_TYPE_INSTRUCTIONS"; /** The logical steps taken to compute the answer. */ readonly THOUGHT_TYPE_STEPS: "THOUGHT_TYPE_STEPS"; }; type ThoughtType = (typeof ThoughtType)[keyof typeof ThoughtType] | (string & {}); declare const MessageError_Type: { readonly TYPE_UNSPECIFIED: "TYPE_UNSPECIFIED"; readonly UNEXPECTED_REPLY_PROCESS_EXCEPTION: "UNEXPECTED_REPLY_PROCESS_EXCEPTION"; readonly GENERIC_CHAT_COMPLETION_EXCEPTION: "GENERIC_CHAT_COMPLETION_EXCEPTION"; /** TokenCounter estimates were off and OpenAi responds with an error due to the token limit. */ readonly CONTEXT_EXCEEDED_EXCEPTION: "CONTEXT_EXCEEDED_EXCEPTION"; readonly DEPLOYMENT_NOT_FOUND_EXCEPTION: "DEPLOYMENT_NOT_FOUND_EXCEPTION"; readonly FUNCTIONS_NOT_AVAILABLE_EXCEPTION: "FUNCTIONS_NOT_AVAILABLE_EXCEPTION"; readonly INVALID_COMPLETION_REQUEST_EXCEPTION: "INVALID_COMPLETION_REQUEST_EXCEPTION"; readonly CONTENT_FILTER_EXCEPTION: "CONTENT_FILTER_EXCEPTION"; readonly FUNCTION_ARGUMENTS_INVALID_JSON_EXCEPTION: "FUNCTION_ARGUMENTS_INVALID_JSON_EXCEPTION"; readonly RETRYABLE_PROCESSING_EXCEPTION: "RETRYABLE_PROCESSING_EXCEPTION"; readonly INVALID_FUNCTION_CALL_EXCEPTION: "INVALID_FUNCTION_CALL_EXCEPTION"; /** Request can not fit into model or the configured limits and TokenCounter registers token limit exceeded. */ readonly LOCAL_CONTEXT_EXCEEDED_EXCEPTION: "LOCAL_CONTEXT_EXCEEDED_EXCEPTION"; readonly CHAT_COMPLETION_NETWORK_EXCEPTION: "CHAT_COMPLETION_NETWORK_EXCEPTION"; readonly INVALID_CHAT_COMPLETION_JSON_EXCEPTION: "INVALID_CHAT_COMPLETION_JSON_EXCEPTION"; readonly GENERIC_CHAT_COMPLETION_SERVICE_EXCEPTION: "GENERIC_CHAT_COMPLETION_SERVICE_EXCEPTION"; readonly WAREHOUSE_ACCESS_MISSING_EXCEPTION: "WAREHOUSE_ACCESS_MISSING_EXCEPTION"; readonly WAREHOUSE_NOT_FOUND_EXCEPTION: "WAREHOUSE_NOT_FOUND_EXCEPTION"; readonly NO_TABLES_TO_QUERY_EXCEPTION: "NO_TABLES_TO_QUERY_EXCEPTION"; readonly SQL_EXECUTION_EXCEPTION: "SQL_EXECUTION_EXCEPTION"; readonly REPLY_PROCESS_TIMEOUT_EXCEPTION: "REPLY_PROCESS_TIMEOUT_EXCEPTION"; readonly COULD_NOT_GET_UC_SCHEMA_EXCEPTION: "COULD_NOT_GET_UC_SCHEMA_EXCEPTION"; readonly INVALID_TABLE_IDENTIFIER_EXCEPTION: "INVALID_TABLE_IDENTIFIER_EXCEPTION"; readonly TOO_MANY_TABLES_EXCEPTION: "TOO_MANY_TABLES_EXCEPTION"; readonly FUNCTION_ARGUMENTS_INVALID_EXCEPTION: "FUNCTION_ARGUMENTS_INVALID_EXCEPTION"; readonly GENERIC_SQL_EXEC_API_CALL_EXCEPTION: "GENERIC_SQL_EXEC_API_CALL_EXCEPTION"; readonly CHAT_COMPLETION_CLIENT_EXCEPTION: "CHAT_COMPLETION_CLIENT_EXCEPTION"; readonly CHAT_COMPLETION_CLIENT_TIMEOUT_EXCEPTION: "CHAT_COMPLETION_CLIENT_TIMEOUT_EXCEPTION"; readonly UNKNOWN_AI_MODEL: "UNKNOWN_AI_MODEL"; readonly TABLES_MISSING_EXCEPTION: "TABLES_MISSING_EXCEPTION"; readonly MESSAGE_DELETED_WHILE_EXECUTING_EXCEPTION: "MESSAGE_DELETED_WHILE_EXECUTING_EXCEPTION"; readonly MESSAGE_UPDATED_WHILE_EXECUTING_EXCEPTION: "MESSAGE_UPDATED_WHILE_EXECUTING_EXCEPTION"; readonly BLOCK_MULTIPLE_EXECUTIONS_EXCEPTION: "BLOCK_MULTIPLE_EXECUTIONS_EXCEPTION"; readonly INVALID_CERTIFIED_ANSWER_IDENTIFIER_EXCEPTION: "INVALID_CERTIFIED_ANSWER_IDENTIFIER_EXCEPTION"; readonly TOO_MANY_CERTIFIED_ANSWERS_EXCEPTION: "TOO_MANY_CERTIFIED_ANSWERS_EXCEPTION"; readonly RATE_LIMIT_EXCEEDED_GENERIC_EXCEPTION: "RATE_LIMIT_EXCEEDED_GENERIC_EXCEPTION"; readonly RATE_LIMIT_EXCEEDED_SPECIFIED_WAIT_EXCEPTION: "RATE_LIMIT_EXCEEDED_SPECIFIED_WAIT_EXCEPTION"; readonly FUNCTION_CALL_MISSING_PARAMETER_EXCEPTION: "FUNCTION_CALL_MISSING_PARAMETER_EXCEPTION"; readonly INVALID_CERTIFIED_ANSWER_FUNCTION_EXCEPTION: "INVALID_CERTIFIED_ANSWER_FUNCTION_EXCEPTION"; readonly ILLEGAL_PARAMETER_DEFINITION_EXCEPTION: "ILLEGAL_PARAMETER_DEFINITION_EXCEPTION"; readonly NO_QUERY_TO_VISUALIZE_EXCEPTION: "NO_QUERY_TO_VISUALIZE_EXCEPTION"; readonly NO_DEPLOYMENTS_AVAILABLE_TO_WORKSPACE: "NO_DEPLOYMENTS_AVAILABLE_TO_WORKSPACE"; readonly STOP_PROCESS_DUE_TO_AUTO_REGENERATE: "STOP_PROCESS_DUE_TO_AUTO_REGENERATE"; readonly FUNCTION_ARGUMENTS_INVALID_TYPE_EXCEPTION: "FUNCTION_ARGUMENTS_INVALID_TYPE_EXCEPTION"; readonly MESSAGE_CANCELLED_WHILE_EXECUTING_EXCEPTION: "MESSAGE_CANCELLED_WHILE_EXECUTING_EXCEPTION"; readonly COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION: "COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION"; readonly GENERATED_SQL_QUERY_TOO_LONG_EXCEPTION: "GENERATED_SQL_QUERY_TOO_LONG_EXCEPTION"; readonly MISSING_SQL_QUERY_EXCEPTION: "MISSING_SQL_QUERY_EXCEPTION"; readonly DESCRIBE_QUERY_UNEXPECTED_FAILURE: "DESCRIBE_QUERY_UNEXPECTED_FAILURE"; readonly DESCRIBE_QUERY_TIMEOUT: "DESCRIBE_QUERY_TIMEOUT"; readonly DESCRIBE_QUERY_INVALID_SQL_ERROR: "DESCRIBE_QUERY_INVALID_SQL_ERROR"; readonly INVALID_SQL_UNKNOWN_TABLE_EXCEPTION: "INVALID_SQL_UNKNOWN_TABLE_EXCEPTION"; readonly INVALID_SQL_MULTIPLE_STATEMENTS_EXCEPTION: "INVALID_SQL_MULTIPLE_STATEMENTS_EXCEPTION"; readonly INVALID_SQL_MULTIPLE_DATASET_REFERENCES_EXCEPTION: "INVALID_SQL_MULTIPLE_DATASET_REFERENCES_EXCEPTION"; readonly MESSAGE_ATTACHMENT_TOO_LONG_ERROR: "MESSAGE_ATTACHMENT_TOO_LONG_ERROR"; readonly INTERNAL_CATALOG_PATH_OVERLAP_EXCEPTION: "INTERNAL_CATALOG_PATH_OVERLAP_EXCEPTION"; readonly INTERNAL_CATALOG_MISSING_UC_PATH_EXCEPTION: "INTERNAL_CATALOG_MISSING_UC_PATH_EXCEPTION"; readonly EXCEEDED_MAX_TOKEN_LENGTH_EXCEPTION: "EXCEEDED_MAX_TOKEN_LENGTH_EXCEPTION"; readonly INTERNAL_CATALOG_ASSET_CREATION_ONGOING_EXCEPTION: "INTERNAL_CATALOG_ASSET_CREATION_ONGOING_EXCEPTION"; readonly INTERNAL_CATALOG_ASSET_CREATION_FAILED_EXCEPTION: "INTERNAL_CATALOG_ASSET_CREATION_FAILED_EXCEPTION"; readonly INTERNAL_CATALOG_ASSET_CREATION_UNSUPPORTED_EXCEPTION: "INTERNAL_CATALOG_ASSET_CREATION_UNSUPPORTED_EXCEPTION"; readonly UNSUPPORTED_CONVERSATION_TYPE_EXCEPTION: "UNSUPPORTED_CONVERSATION_TYPE_EXCEPTION"; readonly COULD_NOT_GET_DASHBOARD_SCHEMA_EXCEPTION: "COULD_NOT_GET_DASHBOARD_SCHEMA_EXCEPTION"; }; type MessageError_Type = (typeof MessageError_Type)[keyof typeof MessageError_Type] | (string & {}); /** * MessageStatus. * The possible values are: * * `FETCHING_METADATA`: Fetching metadata from the data sources. * * `FILTERING_CONTEXT`: Running smart context step to determine relevant context. * * `ASKING_AI`: Waiting for the LLM to respond to the user's question. * * `PENDING_WAREHOUSE`: Waiting for warehouse before the SQL query can start executing. * * `EXECUTING_QUERY`: Executing a generated SQL query. Get the SQL query result by calling [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API. * * `FAILED`: The response generation or query execution failed. See `error` field. * * `COMPLETED`: Message processing is completed. Results are in the `attachments` field. Get the SQL query result by calling [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API. * * `SUBMITTED`: Message has been submitted. * * `QUERY_RESULT_EXPIRED`: SQL result is not available anymore. The user needs to rerun the query. Rerun the SQL query result by calling [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) API. * * `CANCELLED`: Message has been cancelled. */ declare const MessageStatus_MessageStatus: { readonly FETCHING_METADATA: "FETCHING_METADATA"; readonly FILTERING_CONTEXT: "FILTERING_CONTEXT"; readonly ASKING_AI: "ASKING_AI"; readonly PENDING_WAREHOUSE: "PENDING_WAREHOUSE"; readonly EXECUTING_QUERY: "EXECUTING_QUERY"; readonly FAILED: "FAILED"; readonly COMPLETED: "COMPLETED"; readonly SUBMITTED: "SUBMITTED"; readonly QUERY_RESULT_EXPIRED: "QUERY_RESULT_EXPIRED"; readonly CANCELLED: "CANCELLED"; }; type MessageStatus_MessageStatus = (typeof MessageStatus_MessageStatus)[keyof typeof MessageStatus_MessageStatus] | (string & {}); declare const StatementStatus_State: { readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED"; readonly PENDING: "PENDING"; readonly RUNNING: "RUNNING"; readonly SUCCEEDED: "SUCCEEDED"; readonly FAILED: "FAILED"; readonly CANCELED: "CANCELED"; readonly CLOSED: "CLOSED"; }; type StatementStatus_State = (typeof StatementStatus_State)[keyof typeof StatementStatus_State] | (string & {}); interface ChunkInfo { /** The position within the sequence of result set chunks. */ chunkIndex?: number | undefined; /** The starting row offset within the result set. */ rowOffset?: bigint | undefined; /** The number of rows within the result chunk. */ rowCount?: bigint | undefined; /** * The number of bytes in the result chunk. This field is not available when using `INLINE` * disposition. */ byteCount?: bigint | undefined; /** * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are no * more chunks. The next chunk can be fetched with a * :method:statementexecution/getstatementresultchunkn request. */ nextChunkIndex?: number | undefined; /** * When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no more * chunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and should be * treated as an opaque link. This is an alternative to using `next_chunk_index`. */ nextChunkInternalLink?: string | undefined; } interface ColumnInfo { /** Name of Column. */ name?: string | undefined; /** Full data type specification as SQL/catalogString text. */ typeText?: string | undefined; typeName?: ColumnTypeName | undefined; /** Ordinal position of column (starting at position 0). */ position?: number | undefined; /** Digits of precision; required for DecimalTypes. */ typePrecision?: number | undefined; /** Digits to right of decimal; Required for DecimalTypes. */ typeScale?: number | undefined; /** Format of IntervalType. */ typeIntervalType?: string | undefined; /** Full data type specification, JSON-serialized. */ typeJson?: string | undefined; /** User-provided free-form text description. */ comment?: string | undefined; /** Whether field may be Null (default: true). */ nullable?: boolean | undefined; /** Partition index for column. */ partitionIndex?: number | undefined; mask?: ColumnMask | undefined; } interface ColumnMask { /** The full name of the column mask SQL UDF. */ functionName?: string | undefined; /** * The list of additional table columns to be passed as input to the column mask function. The * first arg of the mask function should be of the type of the column being masked and the * types of the rest of the args should match the types of columns in 'using_column_names'. */ usingColumnNames?: string[] | undefined; /** * The list of table columns or literals to be passed as additional arguments to a column mask * function, carrying the type (column reference vs constant literal) of each argument. * Deprecated: use using_column_names instead. */ usingArguments?: PolicyFunctionArgument[] | undefined; } /** * Serialization format for DatabricksServiceException. * Note the definition of this message should be in sync with DatabricksServiceExceptionWithDetailsProto * defined in /api-base/proto/exception_with_details.proto except the later one has an extra error * details field defined. */ interface DatabricksServiceExceptionProto { errorCode?: ErrorCode | undefined; message?: string | undefined; stackTrace?: string | undefined; } interface DownloadMessageAttachmentVisualizationRequest { /** * The resource name of the attachment to render, in the format * `spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}`. */ name?: string | undefined; } interface DownloadMessageAttachmentVisualizationResponse { /** * The rendered visualization as a PNG image. Returned as the raw HTTP * response body rather than a JSON field. */ contents?: ReadableStream | undefined; } interface ExternalLink { /** * A short-lived cloud-storage URL pointing to a chunk of result data, hosted by an external service, with a short * expiration time (<= 15 minutes). As this URL contains a temporary credential, it should be considered sensitive * and the client should not expose this URL in a log. */ externalLink?: string | undefined; /** * Indicates the date-time that the given external link will expire and * becomes invalid, after which point a new `external_link` must be requested. */ expiration?: string | undefined; /** * HTTP headers that must be included with a GET request to the `external_link`. * Each header is provided as a key-value pair. * Headers are typically used to pass a decryption key to the external service. * The values of these headers should be considered sensitive and the client should not expose * these values in a log. */ httpHeaders?: Record | undefined; /** The position within the sequence of result set chunks. */ chunkIndex?: number | undefined; /** The starting row offset within the result set. */ rowOffset?: bigint | undefined; /** The number of rows within the result chunk. */ rowCount?: bigint | undefined; /** * The number of bytes in the result chunk. This field is not available when using `INLINE` * disposition. */ byteCount?: bigint | undefined; /** * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are no * more chunks. The next chunk can be fetched with a * :method:statementexecution/getstatementresultchunkn request. */ nextChunkIndex?: number | undefined; /** * When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no more * chunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and should be * treated as an opaque link. This is an alternative to using `next_chunk_index`. */ nextChunkInternalLink?: string | undefined; } /** Genie AI Response */ interface GenieAttachment { attachment?: { $case: 'text'; /** * Text Attachment if Genie responds with text * This also contains the final summary when available. */ text: TextAttachment; } | { $case: 'query'; /** Query Attachment if Genie responds with a SQL query */ query: GenieQueryAttachment; } | { $case: 'suggestedQuestions'; /** Follow-up questions suggested by Genie */ suggestedQuestions: GenieSuggestedQuestionsAttachment; } | { $case: 'viz'; /** Visualization generated by Genie, if requested via `enable_visualization` */ viz: GenieVizAttachment; } | undefined; /** Attachment ID */ attachmentId?: string | undefined; } /** Request to cancel an in-flight agent-mode response. */ interface GenieCancelResponseRequest { /** The ID of the Genie agent (synonymous with the Genie space ID). */ agentId?: string | undefined; /** The ID of the conversation containing the response. */ conversationId?: string | undefined; /** The ID of the response to cancel (the id from the `response.created` event). */ responseId?: string | undefined; } /** * A Genie conversation. Use chat-mode message endpoints for classic chats and agent-mode * response and item endpoints for agent conversations. Conversation management, feedback, * comments, and attachment operations support both modes. */ interface GenieConversation { /** * Conversation ID. * Legacy identifier, use conversation_id instead */ id?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** ID of the user who created the conversation */ userId?: bigint | undefined; /** Timestamp when the message was created */ createdTimestamp?: bigint | undefined; /** Timestamp when the message was last updated */ lastUpdatedTimestamp?: bigint | undefined; /** Conversation title */ title?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; } interface GenieConversationSummary { conversationId?: string | undefined; title?: string | undefined; createdTimestamp?: bigint | undefined; /** * Whether this is a classic chat or an agent-mode conversation. Allows callers to * route message retrieval (chat vs. agent endpoint) without an extra lookup. */ agentType?: GenieConversationType | undefined; } interface GenieCreateConversationMessageRequest { /** The ID associated with the Genie space where the conversation is started. */ spaceId?: string | undefined; /** The ID associated with the conversation. */ conversationId?: string | undefined; /** User message content. */ content?: string | undefined; /** Enable visualization generation. */ enableVisualization?: boolean | undefined; } interface GenieCreateEvalRunRequest { /** The ID associated with the Genie space where the evaluations will be executed. */ spaceId?: string | undefined; /** List of benchmark question IDs to evaluate. These questions must exist in the specified Genie space. If none are specified, then all benchmark questions are evaluated. */ benchmarkQuestionIds?: string[] | undefined; } interface GenieCreateMessageCommentRequest { /** The ID associated with the Genie space. */ spaceId?: string | undefined; /** The ID associated with the conversation. */ conversationId?: string | undefined; /** The ID associated with the message. */ messageId?: string | undefined; /** Comment text content. */ content?: string | undefined; } interface GenieCreateSpaceRequest { /** Warehouse to associate with the new space */ warehouseId?: string | undefined; /** Parent folder path where the space will be registered */ parentPath?: string | undefined; /** * The contents of the Genie Space in serialized string form. * Use the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field. * This field provides the structure of the JSON string that represents the space's layout and components. */ serializedSpace?: string | undefined; /** Optional title override */ title?: string | undefined; /** Optional description */ description?: string | undefined; } interface GenieDeleteConversationMessageRequest { /** The ID associated with the Genie space where the message is located. */ spaceId?: string | undefined; /** The ID associated with the conversation. */ conversationId?: string | undefined; /** The ID associated with the message to delete. */ messageId?: string | undefined; } interface GenieDeleteConversationRequest { /** The ID associated with the Genie space where the conversation is located. */ spaceId?: string | undefined; /** The ID of the conversation to delete. */ conversationId?: string | undefined; } interface GenieEvalResponse { /** The response content (either text or SQL query). */ response?: string | undefined; /** SQL Statement Execution response. */ sqlExecutionResult?: StatementResponse | undefined; /** Type of response */ responseType?: GenieEvalResponseType | undefined; } /** * Shows summary information for an evaluation result. * For detailed information including SQL execution results, actual/expected responses, and assessment scores, use GenieGetEvalResultDetails. */ interface GenieEvalResult { /** Unique identifier for this evaluation result. */ resultId?: string | undefined; /** The ID of the space the evaluation result belongs to. */ spaceId?: string | undefined; /** The ID of the benchmark question that was evaluated. */ benchmarkQuestionId?: string | undefined; /** Current status of this evaluation result. */ status?: EvaluationStatusType | undefined; /** Stored snapshot of original benchmark question text. */ question?: string | undefined; /** Stored snapshot of original benchmark answer text. */ benchmarkAnswer?: string | undefined; /** User ID who created evaluation result. */ createdByUser?: bigint | undefined; } /** Shows detailed information for an evaluation result. */ interface GenieEvalResultDetails { /** The unique identifier for the evaluation result. */ resultId?: string | undefined; /** The ID of the space the evaluation result belongs to. */ spaceId?: string | undefined; /** The ID of the benchmark question that was evaluated. */ benchmarkQuestionId?: string | undefined; /** Current status of the evaluation run. */ evalRunStatus?: EvaluationStatusType | undefined; /** Assessment of the evaluation result: good, bad, or needs review */ assessment?: GenieEvalAssessment | undefined; /** Whether this evaluation was manually assessed. */ manualAssessment?: boolean | undefined; /** * Reasons for the assessment score. * * Assessment reasons describe why a Genie response was scored as BAD. * * Deterministic values (compared against the ground truth result): * - EMPTY_RESULT: Genie's generated SQL results were empty for this benchmark question. * - RESULT_MISSING_ROWS: Genie's generated SQL response is missing rows from the provided ground truth SQL. * - RESULT_EXTRA_ROWS: Genie's generated SQL response has more rows than the provided ground truth SQL. * - RESULT_MISSING_COLUMNS: Genie's generated SQL response is missing columns from the provided ground truth SQL. * - RESULT_EXTRA_COLUMNS: Genie's generated SQL response has more columns than the provided ground truth SQL. * - SINGLE_CELL_DIFFERENCE: Single value result was produced but differs from ground truth result. * - EMPTY_GOOD_SQL: The benchmark SQL returned an empty result. * - COLUMN_TYPE_DIFFERENCE: The values between the results match but the column type is different. * * LLM judge ratings explain the factors driving BAD results: * - LLM_JUDGE_MISSING_OR_INCORRECT_FILTER: Genie's generated SQL is missing a WHERE clause condition or has incorrect filter logic that excludes/includes wrong data. * - LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT: Genie's generated SQL returns only some of the requested data or columns, missing parts of what the ground truth SQL returns. * - LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST: Genie's generated SQL fundamentally misunderstands what the user is asking for, addressing the wrong question or goal. * - LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC: Genie's generated SQL fails to apply specified instructions or business logic that should be followed. * - LLM_JUDGE_INCORRECT_METRIC_CALCULATION: Genie's generated SQL uses incorrect logic or makes wrong assumptions when calculating metrics. * - LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE: Genie's generated SQL references wrong tables, columns, or uses fields that don't match the ground truth SQL's intent. * - LLM_JUDGE_INCORRECT_FUNCTION_USAGE: Genie's generated SQL uses SQL functions incorrectly or inappropriately (wrong parameters, wrong function for the task, etc.). * - LLM_JUDGE_MISSING_OR_INCORRECT_JOIN: Genie's generated SQL is missing necessary joins between tables or has incorrect join conditions/types that produce wrong results. * - LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION: Genie's generated SQL is missing GROUP BY clauses or has incorrect grouping that doesn't match the requested aggregation level. * - LLM_JUDGE_FORMATTING_ERROR: Genie's generated SQL output has incorrect formatting, ordering (ORDER BY), or presentation issues that don't match expectations. * - LLM_JUDGE_OTHER: LLM judge identified an error that doesn't fall into other categories. * * Deprecated LLM judge values (kept for backward compatibility, do not use): * - LLM_JUDGE_MISSING_JOIN (deprecated) * - LLM_JUDGE_WRONG_FILTER (deprecated) * - LLM_JUDGE_WRONG_AGGREGATION (deprecated) * - LLM_JUDGE_WRONG_COLUMNS (deprecated) * - LLM_JUDGE_SYNTAX_ERROR (deprecated) * - LLM_JUDGE_SEMANTIC_ERROR (deprecated) */ assessmentReasons?: ScoreReason[] | undefined; /** The actual response generated by Genie. */ actualResponse?: GenieEvalResponse[] | undefined; /** The expected responses from the benchmark. */ expectedResponse?: GenieEvalResponse[] | undefined; } /** A benchmark evaluation run. The public benchmark API currently evaluates chat-mode responses. */ interface GenieEvalRunResponse { /** The unique identifier for the evaluation run. */ evalRunId?: string | undefined; /** Current status of the evaluation run. */ evalRunStatus?: EvaluationStatusType | undefined; /** User ID who initiated the evaluation run. */ runByUser?: bigint | undefined; /** Timestamp when the evaluation run was created (milliseconds since epoch). */ createdTimestamp?: bigint | undefined; /** Total number of questions in the evaluation run. */ numQuestions?: bigint | undefined; /** Number of questions answered correctly. */ numCorrect?: bigint | undefined; /** Number of questions that need manual review. */ numNeedsReview?: bigint | undefined; /** Number of questions that have been completed. */ numDone?: bigint | undefined; /** Timestamp when the evaluation run was last updated (milliseconds since epoch). */ lastUpdatedTimestamp?: bigint | undefined; } interface GenieExecuteMessageAttachmentQueryRequest { /** Message ID */ messageId?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** Attachment ID */ attachmentId?: string | undefined; } interface GenieExecuteMessageQueryRequest { /** Message ID */ messageId?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; } /** Feedback containing rating and optional comment */ interface GenieFeedback { /** The feedback rating */ rating?: GenieFeedbackRating | undefined; /** Optional feedback comment text */ comment?: string | undefined; } interface GenieGenerateDownloadFullQueryResultRequest { /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** Message ID */ messageId?: string | undefined; /** Attachment ID */ attachmentId?: string | undefined; } interface GenieGenerateDownloadFullQueryResultResponse { /** Download ID. Use this ID to track the download request in subsequent polling calls */ downloadId?: string | undefined; /** JWT signature for the download_id to ensure secure access to query results */ downloadIdSignature?: string | undefined; } interface GenieGetConversationMessageRequest { /** The ID associated with the Genie space where the target conversation is located. */ spaceId?: string | undefined; /** The ID associated with the target conversation. */ conversationId?: string | undefined; /** The ID associated with the target message from the identified conversation. */ messageId?: string | undefined; } interface GenieGetDownloadFullQueryResultRequest { /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** Message ID */ messageId?: string | undefined; /** Attachment ID */ attachmentId?: string | undefined; /** Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult) */ downloadId?: string | undefined; /** JWT signature for the download_id to ensure secure access to query results */ downloadIdSignature?: string | undefined; } interface GenieGetDownloadFullQueryResultResponse { /** SQL Statement Execution response. See [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) for more details. */ statementResponse?: StatementResponse | undefined; } interface GenieGetEvalResultDetailsRequest { /** The ID associated with the Genie space where the evaluation run is located. */ spaceId?: string | undefined; /** The unique identifier for the evaluation run. */ evalRunId?: string | undefined; /** The unique identifier for the evaluation result. */ resultId?: string | undefined; } interface GenieGetEvalRunRequest { /** The ID associated with the Genie space where the evaluation run is located. */ spaceId?: string | undefined; evalRunId?: string | undefined; } interface GenieGetMessageAttachmentQueryResultRequest { /** Message ID */ messageId?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** Attachment ID */ attachmentId?: string | undefined; } interface GenieGetMessageQueryResultRequest { /** Message ID */ messageId?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; } interface GenieGetMessageQueryResultResponse { /** SQL Statement Execution response. See [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) for more details. */ statementResponse?: StatementResponse | undefined; } interface GenieGetQueryResultByAttachmentRequest { /** Message ID */ messageId?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** Attachment ID */ attachmentId?: string | undefined; } interface GenieGetSpaceRequest { /** The ID associated with the Genie space */ spaceId?: string | undefined; /** * Whether to include the serialized space export in the response. * Requires at least CAN EDIT permission on the space. */ includeSerializedSpace?: boolean | undefined; } interface GenieListConversationCommentsRequest { /** The ID associated with the Genie space. */ spaceId?: string | undefined; /** The ID associated with the conversation. */ conversationId?: string | undefined; /** Maximum number of comments to return per page. */ pageSize?: number | undefined; /** Pagination token for getting the next page of results. */ pageToken?: string | undefined; } interface GenieListConversationCommentsResponse { /** List of comments in the conversation. */ comments?: GenieMessageComment[] | undefined; /** Token to get the next page of results. */ nextPageToken?: string | undefined; } interface GenieListConversationMessagesRequest { /** The ID associated with the Genie space where the conversation is located */ spaceId?: string | undefined; /** The ID of the conversation to list messages from */ conversationId?: string | undefined; /** Maximum number of messages to return per page */ pageSize?: number | undefined; /** Token to get the next page of results */ pageToken?: string | undefined; } interface GenieListConversationMessagesResponse { /** List of messages in the conversation. */ messages?: GenieMessage[] | undefined; /** The token to use for retrieving the next page of results. */ nextPageToken?: string | undefined; } interface GenieListConversationsRequest { /** The ID of the Genie space to retrieve conversations from. */ spaceId?: string | undefined; /** Maximum number of conversations to return per page */ pageSize?: number | undefined; /** Token to get the next page of results */ pageToken?: string | undefined; /** * Include all conversations in the space across all users. * Requires at least CAN MANAGE permission on the space. */ includeAll?: boolean | undefined; } interface GenieListConversationsResponse { /** List of conversations in the Genie space */ conversations?: GenieConversationSummary[] | undefined; /** Token to get the next page of results */ nextPageToken?: string | undefined; } interface GenieListEvalResultsRequest { /** The ID associated with the Genie space where the evaluation run is located. */ spaceId?: string | undefined; /** The unique identifier for the evaluation run. */ evalRunId?: string | undefined; /** Maximum number of eval results to return per page. */ pageSize?: number | undefined; /** Opaque token to retrieve the next page of results. */ pageToken?: string | undefined; } interface GenieListEvalResultsResponse { /** List of evaluation results for the specified run. */ evalResults?: GenieEvalResult[] | undefined; /** The token to use for retrieving the next page of results. */ nextPageToken?: string | undefined; } interface GenieListEvalRunsRequest { /** The ID associated with the Genie space where the evaluation run is located. */ spaceId?: string | undefined; /** Maximum number of evaluation runs to return per page */ pageSize?: number | undefined; /** Token to get the next page of results */ pageToken?: string | undefined; } interface GenieListEvalRunsResponse { /** List of evaluation runs for a space on provided page token and page size */ evalRuns?: GenieEvalRunResponse[] | undefined; /** The token to use for retrieving the next page of results. */ nextPageToken?: string | undefined; } interface GenieListMessageCommentsRequest { /** The ID associated with the Genie space. */ spaceId?: string | undefined; /** The ID associated with the conversation. */ conversationId?: string | undefined; /** The ID associated with the message. */ messageId?: string | undefined; /** Maximum number of comments to return per page. */ pageSize?: number | undefined; /** Pagination token for getting the next page of results. */ pageToken?: string | undefined; } interface GenieListMessageCommentsResponse { /** List of comments on the message. */ comments?: GenieMessageComment[] | undefined; /** Token to get the next page of results. */ nextPageToken?: string | undefined; } interface GenieListSpacesRequest { /** Maximum number of spaces to return per page */ pageSize?: number | undefined; /** Pagination token for getting the next page of results */ pageToken?: string | undefined; } interface GenieListSpacesResponse { /** List of Genie spaces */ spaces?: GenieSpace[] | undefined; /** Token to get the next page of results */ nextPageToken?: string | undefined; } interface GenieMessage { /** * Message ID. * Legacy identifier, use message_id instead */ id?: string | undefined; /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** ID of the user who created the message */ userId?: bigint | undefined; /** Timestamp when the message was created */ createdTimestamp?: bigint | undefined; /** Timestamp when the message was last updated */ lastUpdatedTimestamp?: bigint | undefined; status?: MessageStatus_MessageStatus | undefined; /** User message content */ content?: string | undefined; /** AI-generated response to the message */ attachments?: GenieAttachment[] | undefined; /** * The result of SQL query if the message includes a query attachment. * Deprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead. */ queryResult?: Result | undefined; /** Error message if Genie failed to respond to the message */ error?: MessageError | undefined; /** Message ID */ messageId?: string | undefined; /** User feedback for the message if provided */ feedback?: GenieFeedback | undefined; } /** A comment on a Genie conversation message. */ interface GenieMessageComment { /** Genie space ID */ spaceId?: string | undefined; /** Conversation ID */ conversationId?: string | undefined; /** Message ID */ messageId?: string | undefined; /** Comment ID */ messageCommentId?: string | undefined; /** ID of the user who created the comment */ userId?: bigint | undefined; /** Comment text content */ content?: string | undefined; /** Timestamp when the comment was created */ createdTimestamp?: bigint | undefined; } interface GenieQueryAttachment { /** Name of the query */ title?: string | undefined; /** AI generated SQL query */ query?: string | undefined; /** Description of the query */ description?: string | undefined; /** Time when the user updated the query last */ lastUpdatedTimestamp?: bigint | undefined; parameters?: QueryAttachmentParameter[] | undefined; id?: string | undefined; /** Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data. */ statementId?: string | undefined; /** Metadata associated with the query result. */ queryResultMetadata?: GenieResultMetadata | undefined; /** Insights into how Genie came to generate the SQL. */ thoughts?: Thought[] | undefined; } interface GenieResultMetadata { /** The number of rows in the result set. */ rowCount?: bigint | undefined; /** Indicates whether the result set is truncated. */ isTruncated?: boolean | undefined; } interface GenieSendMessageFeedbackRequest { /** The ID associated with the Genie space where the message is located. */ spaceId?: string | undefined; /** The ID associated with the conversation. */ conversationId?: string | undefined; /** The ID associated with the message to provide feedback for. */ messageId?: string | undefined; /** The rating (POSITIVE, NEGATIVE, or NONE). */ rating?: GenieFeedbackRating | undefined; /** Optional text feedback that will be stored as a comment. */ comment?: string | undefined; } interface GenieSpace { /** Genie space ID */ spaceId?: string | undefined; /** Title of the Genie Space */ title?: string | undefined; /** Description of the Genie Space */ description?: string | undefined; /** Warehouse associated with the Genie Space */ warehouseId?: string | undefined; /** Parent folder path of the Genie Space */ parentPath?: string | undefined; /** * The contents of the Genie Space in serialized string form. * This field is excluded in List Genie spaces responses. * Use the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field. * This field provides the structure of the JSON string that represents the space's layout and components. */ serializedSpace?: string | undefined; /** * ETag for this space. Pass this value back in the update request to prevent overwriting * concurrent changes. */ etag?: string | undefined; /** Time when the Genie space was created. */ createTime?: Temporal.Instant | undefined; /** Time when the Genie space was last modified, matching the value shown in the Genie Agent UI. */ updateTime?: Temporal.Instant | undefined; } interface GenieStartConversationRequest { /** The ID associated with the Genie space where you want to start a conversation. */ spaceId?: string | undefined; /** The text of the message that starts the conversation. */ content?: string | undefined; /** Enable visualization generation. */ enableVisualization?: boolean | undefined; } interface GenieStartConversationResponse { /** Message ID */ messageId?: string | undefined; message?: GenieMessage | undefined; /** Conversation ID */ conversationId?: string | undefined; conversation?: GenieConversation | undefined; } /** Follow-up questions suggested by Genie */ interface GenieSuggestedQuestionsAttachment { /** The suggested follow-up questions */ questions?: string[] | undefined; } interface GenieTrashSpaceRequest { /** The ID associated with the Genie space to be sent to the trash. */ spaceId?: string | undefined; } interface GenieUpdateSpaceRequest { /** Genie space ID */ spaceId?: string | undefined; /** * The contents of the Genie Space in serialized string form (full replacement). * Use the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field. * This field provides the structure of the JSON string that represents the space's layout and components. */ serializedSpace?: string | undefined; /** Optional title override */ title?: string | undefined; /** Optional description */ description?: string | undefined; /** Optional warehouse override */ warehouseId?: string | undefined; /** * ETag returned by a previous GET or UPDATE. When set, the update will fail if the space * has been modified since. Omit to apply the update unconditionally. */ etag?: string | undefined; /** Parent workspace folder path to move this Genie space under. */ parentPath?: string | undefined; } /** * Visualization generated by Genie for a query result. Use the attachment ID * with the download visualization API to retrieve the rendered image. */ interface GenieVizAttachment { /** Name of the visualization */ title?: string | undefined; /** The ID of the query attachment the visualization was generated from */ queryAttachmentId?: string | undefined; } /** * copied from proto3 / Google Well Known Types, source: * https://github.com/protocolbuffers/protobuf/blob/450d24ca820750c5db5112a6f0b0c2efb9758021/src/google/protobuf/struct.proto * `ListValue` is a wrapper around a repeated field of values. * * The JSON representation for `ListValue` is JSON array. */ interface ListValue { /** Repeated field of dynamically typed values. */ values?: Value[] | undefined; } /** * proto compiler is too old and does not support map. * This is wire compatible with map. * See https://developers.google.com/protocol-buffers/docs/proto#backwards_compatibility. */ interface MapStringValueEntry { key?: string | undefined; value?: Value | undefined; } interface MessageError { error?: string | undefined; type?: MessageError_Type | undefined; } interface MessageStatus {} /** * A positional argument passed to a row filter or column mask function. * Distinguishes between column references and literals. */ interface PolicyFunctionArgument { arg?: { $case: 'column'; /** A column reference. */ column: string; } | { $case: 'constant'; /** A constant literal. */ constant: string; } | undefined; } interface QueryAttachmentParameter { keyword?: string | undefined; value?: string | undefined; sqlType?: string | undefined; } interface Result { /** Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data. */ statementId?: string | undefined; /** Row count of the result */ rowCount?: bigint | undefined; /** If result is truncated */ isTruncated?: boolean | undefined; /** JWT corresponding to the statement contained in this result */ statementIdSignature?: string | undefined; } /** * Contains the result data of a single chunk when using `INLINE` disposition. When using * `EXTERNAL_LINKS` disposition, the array `external_links` is used instead to provide * short-lived cloud-storage URLs to the result data * in cloud storage. Exactly one of these alternatives is used. Calls to `getResultData` return * the link for the requested chunk; `executeStatement` and `getStatementResult` responses can * contain links for multiple chunks. */ interface ResultData { externalLinks?: ExternalLink[] | undefined; /** * The `JSON_ARRAY` format is an array of arrays of values, where each non-null value is * formatted as a string. Null values are encoded as JSON `null`. */ dataArray?: ListValue[] | undefined; /** The position within the sequence of result set chunks. */ chunkIndex?: number | undefined; /** The starting row offset within the result set. */ rowOffset?: bigint | undefined; /** The number of rows within the result chunk. */ rowCount?: bigint | undefined; /** * The number of bytes in the result chunk. This field is not available when using `INLINE` * disposition. */ byteCount?: bigint | undefined; /** * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are no * more chunks. The next chunk can be fetched with a * :method:statementexecution/getstatementresultchunkn request. */ nextChunkIndex?: number | undefined; /** * When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no more * chunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and should be * treated as an opaque link. This is an alternative to using `next_chunk_index`. */ nextChunkInternalLink?: string | undefined; } /** The result manifest provides schema and metadata for the result set. */ interface ResultManifest { format?: Format | undefined; schema?: Schema | undefined; /** The total number of chunks that the result set has been divided into. */ totalChunkCount?: number | undefined; /** Array of result set chunk metadata. */ chunks?: ChunkInfo[] | undefined; /** The total number of rows in the result set. */ totalRowCount?: bigint | undefined; /** * The total number of bytes in the result set. This field is not available when using `INLINE` * disposition. */ totalByteCount?: bigint | undefined; /** Indicates whether the result is truncated due to `row_limit` or `byte_limit`. */ truncated?: boolean | undefined; } interface Schema { columnCount?: number | undefined; columns?: ColumnInfo[] | undefined; } interface StatementResponse { /** * The statement ID is returned upon successfully submitting a SQL statement, and is a required * reference for all subsequent calls. */ statementId?: string | undefined; status?: StatementStatus | undefined; manifest?: ResultManifest | undefined; result?: ResultData | undefined; } /** The status response includes execution state and if relevant, error information. */ interface StatementStatus { /** * Statement execution state: * - `PENDING`: waiting for warehouse * - `RUNNING`: running * - `SUCCEEDED`: execution was successful, result data available for fetch * - `FAILED`: execution failed; reason for failure described in accompanying error message * - `CANCELED`: user canceled; can come from explicit cancel call, or timeout with * `on_wait_timeout=CANCEL` * - `CLOSED`: execution successful, and statement closed; result no longer available for fetch */ state?: StatementStatus_State | undefined; error?: DatabricksServiceExceptionProto | undefined; /** * SQLSTATE error code returned when the statement execution fails. * Only populated when the statement status is `FAILED`. */ sqlState?: string | undefined; } /** * copied from proto3 / Google Well Known Types, source: * https://github.com/protocolbuffers/protobuf/blob/450d24ca820750c5db5112a6f0b0c2efb9758021/src/google/protobuf/struct.proto * `Struct` represents a structured data value, consisting of fields * which map to dynamically typed values. In some languages, `Struct` * might be supported by a native representation. For example, in * scripting languages like JS a struct is represented as an * object. The details of that representation are described together * with the proto support for the language. * * The JSON representation for `Struct` is JSON object. */ interface Struct { /** Unordered map of dynamically typed values. */ fields?: MapStringValueEntry[] | undefined; } /** * A text response on a conversation message: the answer, the final summary, or a * clarifying follow-up question, along with optional phase and verification metadata. */ interface TextAttachment { /** AI generated message */ content?: string | undefined; id?: string | undefined; /** * Purpose of this text attachment. A completed message may contain more than * one text attachment (for example a clarifying follow-up question alongside * the final answer); use this field to tell them apart. `TEXT_ATTACHMENT_PURPOSE_ANSWER` * marks the final answer/summary and `FOLLOW_UP_QUESTION` marks a clarifying question. */ purpose?: TextAttachmentPurpose | undefined; } /** A single thought in the AI's reasoning process for a query. */ interface Thought { /** * The category of this thought. * The possible values are: * * `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the question was interpreted. * * `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question were resolved. * * `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were identified as relevant. * * `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were referenced. * * `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer. */ thoughtType?: ThoughtType | undefined; /** The md formatted content for this thought. */ content?: string | undefined; } /** * copied from proto3 / Google Well Known Types, source: * https://github.com/protocolbuffers/protobuf/blob/450d24ca820750c5db5112a6f0b0c2efb9758021/src/google/protobuf/struct.proto * `Value` represents a dynamically typed value which can be either * null, a number, a string, a boolean, a recursive struct value, or a * list of values. A producer of value is expected to set one of these * variants. Absence of any variant indicates an error. * * The JSON representation for `Value` is JSON value. */ interface Value { /** The kind of value. */ kind?: { $case: 'nullValue'; /** Represents a null value. */ nullValue: NullValue; } | { $case: 'numberValue'; /** Represents a double value. */ numberValue: number; } | { $case: 'stringValue'; /** Represents a string value. */ stringValue: string; } | { $case: 'boolValue'; /** Represents a boolean value. */ boolValue: boolean; } | { $case: 'structValue'; /** Represents a structured value. */ structValue: Struct; } | { $case: 'listValue'; /** Represents a repeated `Value`. */ listValue: ListValue; } | undefined; } declare const unmarshalChunkInfoSchema: z.ZodType; declare const unmarshalColumnInfoSchema: z.ZodType; declare const unmarshalColumnMaskSchema: z.ZodType; declare const unmarshalDatabricksServiceExceptionProtoSchema: z.ZodType; declare const unmarshalExternalLinkSchema: z.ZodType; declare const unmarshalGenieAttachmentSchema: z.ZodType; declare const unmarshalGenieConversationSchema: z.ZodType; declare const unmarshalGenieConversationSummarySchema: z.ZodType; declare const unmarshalGenieEvalResponseSchema: z.ZodType; declare const unmarshalGenieEvalResultSchema: z.ZodType; declare const unmarshalGenieEvalResultDetailsSchema: z.ZodType; declare const unmarshalGenieEvalRunResponseSchema: z.ZodType; declare const unmarshalGenieFeedbackSchema: z.ZodType; declare const unmarshalGenieGenerateDownloadFullQueryResultResponseSchema: z.ZodType; declare const unmarshalGenieGetDownloadFullQueryResultResponseSchema: z.ZodType; declare const unmarshalGenieGetMessageQueryResultResponseSchema: z.ZodType; declare const unmarshalGenieListConversationCommentsResponseSchema: z.ZodType; declare const unmarshalGenieListConversationMessagesResponseSchema: z.ZodType; declare const unmarshalGenieListConversationsResponseSchema: z.ZodType; declare const unmarshalGenieListEvalResultsResponseSchema: z.ZodType; declare const unmarshalGenieListEvalRunsResponseSchema: z.ZodType; declare const unmarshalGenieListMessageCommentsResponseSchema: z.ZodType; declare const unmarshalGenieListSpacesResponseSchema: z.ZodType; declare const unmarshalGenieMessageSchema: z.ZodType; declare const unmarshalGenieMessageCommentSchema: z.ZodType; declare const unmarshalGenieQueryAttachmentSchema: z.ZodType; declare const unmarshalGenieResultMetadataSchema: z.ZodType; declare const unmarshalGenieSpaceSchema: z.ZodType; declare const unmarshalGenieStartConversationResponseSchema: z.ZodType; declare const unmarshalGenieSuggestedQuestionsAttachmentSchema: z.ZodType; declare const unmarshalGenieVizAttachmentSchema: z.ZodType; declare const unmarshalListValueSchema: z.ZodType; declare const unmarshalMapStringValueEntrySchema: z.ZodType; declare const unmarshalMessageErrorSchema: z.ZodType; declare const unmarshalPolicyFunctionArgumentSchema: z.ZodType; declare const unmarshalQueryAttachmentParameterSchema: z.ZodType; declare const unmarshalResultSchema: z.ZodType; declare const unmarshalResultDataSchema: z.ZodType; declare const unmarshalResultManifestSchema: z.ZodType; declare const unmarshalSchemaSchema: z.ZodType; declare const unmarshalStatementResponseSchema: z.ZodType; declare const unmarshalStatementStatusSchema: z.ZodType; declare const unmarshalStructSchema: z.ZodType; declare const unmarshalTextAttachmentSchema: z.ZodType; declare const unmarshalThoughtSchema: z.ZodType; declare const unmarshalValueSchema: z.ZodType; declare const marshalGenieCancelResponseRequestSchema: z.ZodType; declare const marshalGenieCreateConversationMessageRequestSchema: z.ZodType; declare const marshalGenieCreateEvalRunRequestSchema: z.ZodType; declare const marshalGenieCreateMessageCommentRequestSchema: z.ZodType; declare const marshalGenieCreateSpaceRequestSchema: z.ZodType; declare const marshalGenieExecuteMessageAttachmentQueryRequestSchema: z.ZodType; declare const marshalGenieExecuteMessageQueryRequestSchema: z.ZodType; declare const marshalGenieGenerateDownloadFullQueryResultRequestSchema: z.ZodType; declare const marshalGenieSendMessageFeedbackRequestSchema: z.ZodType; declare const marshalGenieStartConversationRequestSchema: z.ZodType; declare const marshalGenieUpdateSpaceRequestSchema: z.ZodType; //#endregion export { ChunkInfo, ColumnInfo, ColumnMask, ColumnTypeName, DatabricksServiceExceptionProto, DownloadMessageAttachmentVisualizationRequest, DownloadMessageAttachmentVisualizationResponse, ErrorCode, EvaluationStatusType, ExternalLink, Format, GenieAttachment, GenieCancelResponseRequest, GenieConversation, GenieConversationSummary, GenieConversationType, GenieCreateConversationMessageRequest, GenieCreateEvalRunRequest, GenieCreateMessageCommentRequest, GenieCreateSpaceRequest, GenieDeleteConversationMessageRequest, GenieDeleteConversationRequest, GenieEvalAssessment, GenieEvalResponse, GenieEvalResponseType, GenieEvalResult, GenieEvalResultDetails, GenieEvalRunResponse, GenieExecuteMessageAttachmentQueryRequest, GenieExecuteMessageQueryRequest, GenieFeedback, GenieFeedbackRating, GenieGenerateDownloadFullQueryResultRequest, GenieGenerateDownloadFullQueryResultResponse, GenieGetConversationMessageRequest, GenieGetDownloadFullQueryResultRequest, GenieGetDownloadFullQueryResultResponse, GenieGetEvalResultDetailsRequest, GenieGetEvalRunRequest, GenieGetMessageAttachmentQueryResultRequest, GenieGetMessageQueryResultRequest, GenieGetMessageQueryResultResponse, GenieGetQueryResultByAttachmentRequest, GenieGetSpaceRequest, GenieListConversationCommentsRequest, GenieListConversationCommentsResponse, GenieListConversationMessagesRequest, GenieListConversationMessagesResponse, GenieListConversationsRequest, GenieListConversationsResponse, GenieListEvalResultsRequest, GenieListEvalResultsResponse, GenieListEvalRunsRequest, GenieListEvalRunsResponse, GenieListMessageCommentsRequest, GenieListMessageCommentsResponse, GenieListSpacesRequest, GenieListSpacesResponse, GenieMessage, GenieMessageComment, GenieQueryAttachment, GenieResultMetadata, GenieSendMessageFeedbackRequest, GenieSpace, GenieStartConversationRequest, GenieStartConversationResponse, GenieSuggestedQuestionsAttachment, GenieTrashSpaceRequest, GenieUpdateSpaceRequest, GenieVizAttachment, ListValue, MapStringValueEntry, MessageError, MessageError_Type, MessageStatus, MessageStatus_MessageStatus, NullValue, PolicyFunctionArgument, QueryAttachmentParameter, Result, ResultData, ResultManifest, Schema, ScoreReason, StatementResponse, StatementStatus, StatementStatus_State, Struct, TextAttachment, TextAttachmentPurpose, Thought, ThoughtType, Value, marshalGenieCancelResponseRequestSchema, marshalGenieCreateConversationMessageRequestSchema, marshalGenieCreateEvalRunRequestSchema, marshalGenieCreateMessageCommentRequestSchema, marshalGenieCreateSpaceRequestSchema, marshalGenieExecuteMessageAttachmentQueryRequestSchema, marshalGenieExecuteMessageQueryRequestSchema, marshalGenieGenerateDownloadFullQueryResultRequestSchema, marshalGenieSendMessageFeedbackRequestSchema, marshalGenieStartConversationRequestSchema, marshalGenieUpdateSpaceRequestSchema, unmarshalChunkInfoSchema, unmarshalColumnInfoSchema, unmarshalColumnMaskSchema, unmarshalDatabricksServiceExceptionProtoSchema, unmarshalExternalLinkSchema, unmarshalGenieAttachmentSchema, unmarshalGenieConversationSchema, unmarshalGenieConversationSummarySchema, unmarshalGenieEvalResponseSchema, unmarshalGenieEvalResultDetailsSchema, unmarshalGenieEvalResultSchema, unmarshalGenieEvalRunResponseSchema, unmarshalGenieFeedbackSchema, unmarshalGenieGenerateDownloadFullQueryResultResponseSchema, unmarshalGenieGetDownloadFullQueryResultResponseSchema, unmarshalGenieGetMessageQueryResultResponseSchema, unmarshalGenieListConversationCommentsResponseSchema, unmarshalGenieListConversationMessagesResponseSchema, unmarshalGenieListConversationsResponseSchema, unmarshalGenieListEvalResultsResponseSchema, unmarshalGenieListEvalRunsResponseSchema, unmarshalGenieListMessageCommentsResponseSchema, unmarshalGenieListSpacesResponseSchema, unmarshalGenieMessageCommentSchema, unmarshalGenieMessageSchema, unmarshalGenieQueryAttachmentSchema, unmarshalGenieResultMetadataSchema, unmarshalGenieSpaceSchema, unmarshalGenieStartConversationResponseSchema, unmarshalGenieSuggestedQuestionsAttachmentSchema, unmarshalGenieVizAttachmentSchema, unmarshalListValueSchema, unmarshalMapStringValueEntrySchema, unmarshalMessageErrorSchema, unmarshalPolicyFunctionArgumentSchema, unmarshalQueryAttachmentParameterSchema, unmarshalResultDataSchema, unmarshalResultManifestSchema, unmarshalResultSchema, unmarshalSchemaSchema, unmarshalStatementResponseSchema, unmarshalStatementStatusSchema, unmarshalStructSchema, unmarshalTextAttachmentSchema, unmarshalThoughtSchema, unmarshalValueSchema }; //# sourceMappingURL=model.d.ts.map