ml

type Activity struct {
	// Type of activity. Valid values are: * `APPLIED_TRANSITION`: User applied
	// the corresponding stage transition.
	//
	// * `REQUESTED_TRANSITION`: User requested the corresponding stage
	// transition.
	//
	// * `CANCELLED_REQUEST`: User cancelled an existing transition request.
	//
	// * `APPROVED_REQUEST`: User approved the corresponding stage transition.
	//
	// * `REJECTED_REQUEST`: User rejected the coressponding stage transition.
	//
	// * `SYSTEM_TRANSITION`: For events performed as a side effect, such as
	// archiving existing model versions in a stage.
	// Wire name: 'activity_type'
	ActivityType ActivityType `json:"activity_type,omitempty"`
	// User-provided comment associated with the activity.
	// Wire name: 'comment'
	Comment string `json:"comment,omitempty"`
	// Creation time of the object, as a Unix timestamp in milliseconds.
	// Wire name: 'creation_timestamp'
	CreationTimestamp int64 `json:"creation_timestamp,omitempty"`
	// Source stage of the transition (if the activity is stage transition
	// related). Valid values are:
	//
	// * `None`: The initial stage of a model version.
	//
	// * `Staging`: Staging or pre-production stage.
	//
	// * `Production`: Production stage.
	//
	// * `Archived`: Archived stage.
	// Wire name: 'from_stage'
	FromStage Stage `json:"from_stage,omitempty"`
	// Unique identifier for the object.
	// Wire name: 'id'
	Id string `json:"id,omitempty"`
	// Time of the object at last update, as a Unix timestamp in milliseconds.
	// Wire name: 'last_updated_timestamp'
	LastUpdatedTimestamp int64 `json:"last_updated_timestamp,omitempty"`
	// Comment made by system, for example explaining an activity of type
	// `SYSTEM_TRANSITION`. It usually describes a side effect, such as a
	// version being archived as part of another version's stage transition, and
	// may not be returned for some activity types.
	// Wire name: 'system_comment'
	SystemComment string `json:"system_comment,omitempty"`
	// Target stage of the transition (if the activity is stage transition
	// related). Valid values are:
	//
	// * `None`: The initial stage of a model version.
	//
	// * `Staging`: Staging or pre-production stage.
	//
	// * `Production`: Production stage.
	//
	// * `Archived`: Archived stage.
	// Wire name: 'to_stage'
	ToStage Stage `json:"to_stage,omitempty"`
	// The username of the user that created the object.
	// Wire name: 'user_id'
	UserId string `json:"user_id,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ActivityAction string

type ActivityType string

type ApproveTransitionRequest struct {
	// Specifies whether to archive all current model versions in the target
	// stage.
	// Wire name: 'archive_existing_versions'
	ArchiveExistingVersions bool `json:"archive_existing_versions"`
	// User-provided comment on the action.
	// Wire name: 'comment'
	Comment string `json:"comment,omitempty"`
	// Name of the model.
	// Wire name: 'name'
	Name string `json:"name"`
	// Target stage of the transition. Valid values are:
	//
	// * `None`: The initial stage of a model version.
	//
	// * `Staging`: Staging or pre-production stage.
	//
	// * `Production`: Production stage.
	//
	// * `Archived`: Archived stage.
	// Wire name: 'stage'
	Stage Stage `json:"stage"`
	// Version of the model.
	// Wire name: 'version'
	Version string `json:"version"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ApproveTransitionRequestResponse struct {
	// Activity recorded for the action.
	// Wire name: 'activity'
	Activity *Activity `json:"activity,omitempty"`
}

type CommentActivityAction string

type CommentObject struct {
	// Array of actions on the activity allowed for the current viewer.
	// Wire name: 'available_actions'
	AvailableActions []CommentActivityAction `json:"available_actions,omitempty"`
	// User-provided comment on the action.
	// Wire name: 'comment'
	Comment string `json:"comment,omitempty"`
	// Creation time of the object, as a Unix timestamp in milliseconds.
	// Wire name: 'creation_timestamp'
	CreationTimestamp int64 `json:"creation_timestamp,omitempty"`
	// Comment ID
	// Wire name: 'id'
	Id string `json:"id,omitempty"`
	// Time of the object at last update, as a Unix timestamp in milliseconds.
	// Wire name: 'last_updated_timestamp'
	LastUpdatedTimestamp int64 `json:"last_updated_timestamp,omitempty"`
	// The username of the user that created the object.
	// Wire name: 'user_id'
	UserId string `json:"user_id,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateComment struct {
	// User-provided comment on the action.
	// Wire name: 'comment'
	Comment string `json:"comment"`
	// Name of the model.
	// Wire name: 'name'
	Name string `json:"name"`
	// Version of the model.
	// Wire name: 'version'
	Version string `json:"version"`
}

type CreateCommentResponse struct {
	// Comment details.
	// Wire name: 'comment'
	Comment *CommentObject `json:"comment,omitempty"`
}

type CreateExperiment struct {
	// Location where all artifacts for the experiment are stored. If not
	// provided, the remote server will select an appropriate default.
	// Wire name: 'artifact_location'
	ArtifactLocation string `json:"artifact_location,omitempty"`
	// Experiment name.
	// Wire name: 'name'
	Name string `json:"name"`
	// A collection of tags to set on the experiment. Maximum tag size and
	// number of tags per request depends on the storage backend. All storage
	// backends are guaranteed to support tag keys up to 250 bytes in size and
	// tag values up to 5000 bytes in size. All storage backends are also
	// guaranteed to support up to 20 tags per request.
	// Wire name: 'tags'
	Tags []ExperimentTag `json:"tags,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateExperimentResponse struct {
	// Unique identifier for the experiment.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateForecastingExperimentRequest struct {
	// The column in the training table used to customize weights for each time
	// series.
	// Wire name: 'custom_weights_column'
	CustomWeightsColumn string `json:"custom_weights_column,omitempty"`
	// The path in the workspace to store the created experiment.
	// Wire name: 'experiment_path'
	ExperimentPath string `json:"experiment_path,omitempty"`
	// The time interval between consecutive rows in the time series data.
	// Possible values include: '1 second', '1 minute', '5 minutes', '10
	// minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly',
	// 'Monthly', 'Quarterly', 'Yearly'.
	// Wire name: 'forecast_granularity'
	ForecastGranularity string `json:"forecast_granularity"`
	// The number of time steps into the future to make predictions, calculated
	// as a multiple of forecast_granularity. This value represents how far
	// ahead the model should forecast.
	// Wire name: 'forecast_horizon'
	ForecastHorizon int64 `json:"forecast_horizon"`
	// The fully qualified path of a Unity Catalog table, formatted as
	// catalog_name.schema_name.table_name, used to store future feature data
	// for predictions.
	// Wire name: 'future_feature_data_path'
	FutureFeatureDataPath string `json:"future_feature_data_path,omitempty"`
	// The region code(s) to automatically add holiday features. Currently
	// supports only one region.
	// Wire name: 'holiday_regions'
	HolidayRegions []string `json:"holiday_regions,omitempty"`
	// Specifies the list of feature columns to include in model training. These
	// columns must exist in the training data and be of type string, numerical,
	// or boolean. If not specified, no additional features will be included.
	// Note: Certain columns are automatically handled: - Automatically
	// excluded: split_column, target_column, custom_weights_column. -
	// Automatically included: time_column.
	// Wire name: 'include_features'
	IncludeFeatures []string `json:"include_features,omitempty"`
	// The maximum duration for the experiment in minutes. The experiment stops
	// automatically if it exceeds this limit.
	// Wire name: 'max_runtime'
	MaxRuntime int64 `json:"max_runtime,omitempty"`
	// The fully qualified path of a Unity Catalog table, formatted as
	// catalog_name.schema_name.table_name, used to store predictions.
	// Wire name: 'prediction_data_path'
	PredictionDataPath string `json:"prediction_data_path,omitempty"`
	// The evaluation metric used to optimize the forecasting model.
	// Wire name: 'primary_metric'
	PrimaryMetric string `json:"primary_metric,omitempty"`
	// The fully qualified path of a Unity Catalog model, formatted as
	// catalog_name.schema_name.model_name, used to store the best model.
	// Wire name: 'register_to'
	RegisterTo string `json:"register_to,omitempty"`
	// // The column in the training table used for custom data splits. Values
	// must be 'train', 'validate', or 'test'.
	// Wire name: 'split_column'
	SplitColumn string `json:"split_column,omitempty"`
	// The column in the input training table used as the prediction target for
	// model training. The values in this column are used as the ground truth
	// for model training.
	// Wire name: 'target_column'
	TargetColumn string `json:"target_column"`
	// The column in the input training table that represents each row's
	// timestamp.
	// Wire name: 'time_column'
	TimeColumn string `json:"time_column"`
	// The column in the training table used to group the dataset for predicting
	// individual time series.
	// Wire name: 'timeseries_identifier_columns'
	TimeseriesIdentifierColumns []string `json:"timeseries_identifier_columns,omitempty"`
	// The fully qualified path of a Unity Catalog table, formatted as
	// catalog_name.schema_name.table_name, used as training data for the
	// forecasting model.
	// Wire name: 'train_data_path'
	TrainDataPath string `json:"train_data_path"`
	// List of frameworks to include for model tuning. Possible values are
	// 'Prophet', 'ARIMA', 'DeepAR'. An empty list includes all supported
	// frameworks.
	// Wire name: 'training_frameworks'
	TrainingFrameworks []string `json:"training_frameworks,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateForecastingExperimentResponse struct {
	// The unique ID of the created forecasting experiment
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateLoggedModelRequest struct {
	// The ID of the experiment that owns the model.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id"`
	// The type of the model, such as “"Agent"“, “"Classifier"“, “"LLM"“.
	// Wire name: 'model_type'
	ModelType string `json:"model_type,omitempty"`
	// The name of the model (optional). If not specified one will be generated.
	// Wire name: 'name'
	Name string `json:"name,omitempty"`
	// Parameters attached to the model.
	// Wire name: 'params'
	Params []LoggedModelParameter `json:"params,omitempty"`
	// The ID of the run that created the model.
	// Wire name: 'source_run_id'
	SourceRunId string `json:"source_run_id,omitempty"`
	// Tags attached to the model.
	// Wire name: 'tags'
	Tags []LoggedModelTag `json:"tags,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateLoggedModelResponse struct {
	// The newly created logged model.
	// Wire name: 'model'
	Model *LoggedModel `json:"model,omitempty"`
}

type CreateModelRequest struct {
	// Optional description for registered model.
	// Wire name: 'description'
	Description string `json:"description,omitempty"`
	// Register models under this name
	// Wire name: 'name'
	Name string `json:"name"`
	// Additional metadata for registered model.
	// Wire name: 'tags'
	Tags []ModelTag `json:"tags,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateModelResponse struct {

	// Wire name: 'registered_model'
	RegisteredModel *Model `json:"registered_model,omitempty"`
}

type CreateModelVersionRequest struct {
	// Optional description for model version.
	// Wire name: 'description'
	Description string `json:"description,omitempty"`
	// Register model under this name
	// Wire name: 'name'
	Name string `json:"name"`
	// MLflow run ID for correlation, if `source` was generated by an experiment
	// run in MLflow tracking server
	// Wire name: 'run_id'
	RunId string `json:"run_id,omitempty"`
	// MLflow run link - this is the exact link of the run that generated this
	// model version, potentially hosted at another instance of MLflow.
	// Wire name: 'run_link'
	RunLink string `json:"run_link,omitempty"`
	// URI indicating the location of the model artifacts.
	// Wire name: 'source'
	Source string `json:"source"`
	// Additional metadata for model version.
	// Wire name: 'tags'
	Tags []ModelVersionTag `json:"tags,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateModelVersionResponse struct {
	// Return new version number generated for this model in registry.
	// Wire name: 'model_version'
	ModelVersion *ModelVersion `json:"model_version,omitempty"`
}

type CreateOnlineStoreRequest struct {
	// An OnlineStore is a logical database instance that stores and serves
	// features online.
	// Wire name: 'online_store'
	OnlineStore OnlineStore `json:"online_store"`
}

type CreateRegistryWebhook struct {
	// User-specified description for the webhook.
	// Wire name: 'description'
	Description string `json:"description,omitempty"`
	// Events that can trigger a registry webhook: * `MODEL_VERSION_CREATED`: A
	// new model version was created for the associated model.
	//
	// * `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was
	// changed.
	//
	// * `TRANSITION_REQUEST_CREATED`: A user requested a model version’s
	// stage be transitioned.
	//
	// * `COMMENT_CREATED`: A user wrote a comment on a registered model.
	//
	// * `REGISTERED_MODEL_CREATED`: A new registered model was created. This
	// event type can only be specified for a registry-wide webhook, which can
	// be created by not specifying a model name in the create request.
	//
	// * `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.
	//
	// * `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was
	// transitioned to staging.
	//
	// * `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was
	// transitioned to production.
	//
	// * `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.
	//
	// * `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model
	// version be transitioned to staging.
	//
	// * `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model
	// version be transitioned to production.
	//
	// * `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model
	// version be archived.
	// Wire name: 'events'
	Events []RegistryWebhookEvent `json:"events"`

	// Wire name: 'http_url_spec'
	HttpUrlSpec *HttpUrlSpec `json:"http_url_spec,omitempty"`

	// Wire name: 'job_spec'
	JobSpec *JobSpec `json:"job_spec,omitempty"`
	// If model name is not specified, a registry-wide webhook is created that
	// listens for the specified events across all versions of all registered
	// models.
	// Wire name: 'model_name'
	ModelName string `json:"model_name,omitempty"`
	// Enable or disable triggering the webhook, or put the webhook into test
	// mode. The default is `ACTIVE`: * `ACTIVE`: Webhook is triggered when an
	// associated event happens.
	//
	// * `DISABLED`: Webhook is not triggered.
	//
	// * `TEST_MODE`: Webhook can be triggered through the test endpoint, but is
	// not triggered on a real event.
	// Wire name: 'status'
	Status RegistryWebhookStatus `json:"status,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateRun struct {
	// ID of the associated experiment.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id,omitempty"`
	// The name of the run.
	// Wire name: 'run_name'
	RunName string `json:"run_name,omitempty"`
	// Unix timestamp in milliseconds of when the run started.
	// Wire name: 'start_time'
	StartTime int64 `json:"start_time,omitempty"`
	// Additional metadata for run.
	// Wire name: 'tags'
	Tags []RunTag `json:"tags,omitempty"`
	// ID of the user executing the run. This field is deprecated as of MLflow
	// 1.0, and will be removed in a future MLflow release. Use 'mlflow.user'
	// tag instead.
	// Wire name: 'user_id'
	UserId string `json:"user_id,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateRunResponse struct {
	// The newly created run.
	// Wire name: 'run'
	Run *Run `json:"run,omitempty"`
}

type CreateTransitionRequest struct {
	// User-provided comment on the action.
	// Wire name: 'comment'
	Comment string `json:"comment,omitempty"`
	// Name of the model.
	// Wire name: 'name'
	Name string `json:"name"`
	// Target stage of the transition. Valid values are:
	//
	// * `None`: The initial stage of a model version.
	//
	// * `Staging`: Staging or pre-production stage.
	//
	// * `Production`: Production stage.
	//
	// * `Archived`: Archived stage.
	// Wire name: 'stage'
	Stage Stage `json:"stage"`
	// Version of the model.
	// Wire name: 'version'
	Version string `json:"version"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type CreateTransitionRequestResponse struct {
	// Transition request details.
	// Wire name: 'request'
	Request *TransitionRequest `json:"request,omitempty"`
}

type CreateWebhookResponse struct {

	// Wire name: 'webhook'
	Webhook *RegistryWebhook `json:"webhook,omitempty"`
}

type Dataset struct {
	// Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies
	// it within datasets of the same name.
	// Wire name: 'digest'
	Digest string `json:"digest"`
	// The name of the dataset. E.g. “my.uc.table@2” “nyc-taxi-dataset”,
	// “fantastic-elk-3”
	// Wire name: 'name'
	Name string `json:"name"`
	// The profile of the dataset. Summary statistics for the dataset, such as
	// the number of rows in a table, the mean / std / mode of each column in a
	// table, or the number of elements in an array.
	// Wire name: 'profile'
	Profile string `json:"profile,omitempty"`
	// The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe,
	// MLflow TensorSpec JSON for an ndarray, or another schema format.
	// Wire name: 'schema'
	Schema string `json:"schema,omitempty"`
	// Source information for the dataset. Note that the source may not exactly
	// reproduce the dataset if it was transformed / modified before use with
	// MLflow.
	// Wire name: 'source'
	Source string `json:"source"`
	// The type of the dataset source, e.g. ‘databricks-uc-table’,
	// ‘DBFS’, ‘S3’, ...
	// Wire name: 'source_type'
	SourceType string `json:"source_type"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type DatasetInput struct {
	// The dataset being used as a Run input.
	// Wire name: 'dataset'
	Dataset Dataset `json:"dataset"`
	// A list of tags for the dataset input, e.g. a “context” tag with value
	// “training”
	// Wire name: 'tags'
	Tags []InputTag `json:"tags,omitempty"`
}

type DeleteCommentRequest struct {
	// Unique identifier of an activity
	Id string `json:"-" tf:"-"`
}

type DeleteCommentResponse struct {
}

type DeleteExperiment struct {
	// ID of the associated experiment.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id"`
}

type DeleteExperimentResponse struct {
}

type DeleteLoggedModelRequest struct {
	// The ID of the logged model to delete.
	ModelId string `json:"-" tf:"-"`
}

type DeleteLoggedModelResponse struct {
}

type DeleteLoggedModelTagRequest struct {
	// The ID of the logged model to delete the tag from.
	ModelId string `json:"-" tf:"-"`
	// The tag key.
	TagKey string `json:"-" tf:"-"`
}

type DeleteLoggedModelTagResponse struct {
}

type DeleteModelRequest struct {
	// Registered model unique name identifier.
	Name string `json:"-" tf:"-"`
}

type DeleteModelResponse struct {
}

type DeleteModelTagRequest struct {
	// Name of the tag. The name must be an exact match; wild-card deletion is
	// not supported. Maximum size is 250 bytes.
	Key string `json:"-" tf:"-"`
	// Name of the registered model that the tag was logged under.
	Name string `json:"-" tf:"-"`
}

type DeleteModelTagResponse struct {
}

type DeleteModelVersionRequest struct {
	// Name of the registered model
	Name string `json:"-" tf:"-"`
	// Model version number
	Version string `json:"-" tf:"-"`
}

type DeleteModelVersionResponse struct {
}

type DeleteModelVersionTagRequest struct {
	// Name of the tag. The name must be an exact match; wild-card deletion is
	// not supported. Maximum size is 250 bytes.
	Key string `json:"-" tf:"-"`
	// Name of the registered model that the tag was logged under.
	Name string `json:"-" tf:"-"`
	// Model version number that the tag was logged under.
	Version string `json:"-" tf:"-"`
}

type DeleteModelVersionTagResponse struct {
}

type DeleteOnlineStoreRequest struct {
	// Name of the online store to delete.
	Name string `json:"-" tf:"-"`
}

type DeleteOnlineStoreResponse struct {
}

type DeleteRun struct {
	// ID of the run to delete.
	// Wire name: 'run_id'
	RunId string `json:"run_id"`
}

type DeleteRunResponse struct {
}

type DeleteRuns struct {
	// The ID of the experiment containing the runs to delete.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id"`
	// An optional positive integer indicating the maximum number of runs to
	// delete. The maximum allowed value for max_runs is 10000.
	// Wire name: 'max_runs'
	MaxRuns int `json:"max_runs,omitempty"`
	// The maximum creation timestamp in milliseconds since the UNIX epoch for
	// deleting runs. Only runs created prior to or at this timestamp are
	// deleted.
	// Wire name: 'max_timestamp_millis'
	MaxTimestampMillis int64 `json:"max_timestamp_millis"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type DeleteRunsResponse struct {
	// The number of runs deleted.
	// Wire name: 'runs_deleted'
	RunsDeleted int `json:"runs_deleted,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type DeleteTag struct {
	// Name of the tag. Maximum size is 255 bytes. Must be provided.
	// Wire name: 'key'
	Key string `json:"key"`
	// ID of the run that the tag was logged under. Must be provided.
	// Wire name: 'run_id'
	RunId string `json:"run_id"`
}

type DeleteTagResponse struct {
}

type DeleteTransitionRequestRequest struct {
	// User-provided comment on the action.
	Comment string `json:"-" tf:"-"`
	// Username of the user who created this request. Of the transition requests
	// matching the specified details, only the one transition created by this
	// user will be deleted.
	Creator string `json:"-" tf:"-"`
	// Name of the model.
	Name string `json:"-" tf:"-"`
	// Target stage of the transition request. Valid values are:
	//
	// * `None`: The initial stage of a model version.
	//
	// * `Staging`: Staging or pre-production stage.
	//
	// * `Production`: Production stage.
	//
	// * `Archived`: Archived stage.
	Stage DeleteTransitionRequestStage `json:"-" tf:"-"`
	// Version of the model.
	Version string `json:"-" tf:"-"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type DeleteTransitionRequestResponse struct {
}

type DeleteTransitionRequestStage string

type DeleteWebhookRequest struct {
	// Webhook ID required to delete a registry webhook.
	Id string `json:"-" tf:"-"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type DeleteWebhookResponse struct {
}

type Experiment struct {
	// Location where artifacts for the experiment are stored.
	// Wire name: 'artifact_location'
	ArtifactLocation string `json:"artifact_location,omitempty"`
	// Creation time
	// Wire name: 'creation_time'
	CreationTime int64 `json:"creation_time,omitempty"`
	// Unique identifier for the experiment.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id,omitempty"`
	// Last update time
	// Wire name: 'last_update_time'
	LastUpdateTime int64 `json:"last_update_time,omitempty"`
	// Current life cycle stage of the experiment: "active" or "deleted".
	// Deleted experiments are not returned by APIs.
	// Wire name: 'lifecycle_stage'
	LifecycleStage string `json:"lifecycle_stage,omitempty"`
	// Human readable name that identifies the experiment.
	// Wire name: 'name'
	Name string `json:"name,omitempty"`
	// Tags: Additional metadata key-value pairs.
	// Wire name: 'tags'
	Tags []ExperimentTag `json:"tags,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentAccessControlRequest struct {
	// name of the group
	// Wire name: 'group_name'
	GroupName string `json:"group_name,omitempty"`
	// Permission level
	// Wire name: 'permission_level'
	PermissionLevel ExperimentPermissionLevel `json:"permission_level,omitempty"`
	// application ID of a service principal
	// Wire name: 'service_principal_name'
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	// Wire name: 'user_name'
	UserName string `json:"user_name,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentAccessControlResponse struct {
	// All permissions.
	// Wire name: 'all_permissions'
	AllPermissions []ExperimentPermission `json:"all_permissions,omitempty"`
	// Display name of the user or service principal.
	// Wire name: 'display_name'
	DisplayName string `json:"display_name,omitempty"`
	// name of the group
	// Wire name: 'group_name'
	GroupName string `json:"group_name,omitempty"`
	// Name of the service principal.
	// Wire name: 'service_principal_name'
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	// Wire name: 'user_name'
	UserName string `json:"user_name,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentPermission struct {

	// Wire name: 'inherited'
	Inherited bool `json:"inherited,omitempty"`

	// Wire name: 'inherited_from_object'
	InheritedFromObject []string `json:"inherited_from_object,omitempty"`
	// Permission level
	// Wire name: 'permission_level'
	PermissionLevel ExperimentPermissionLevel `json:"permission_level,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentPermissionLevel string

type ExperimentPermissions struct {

	// Wire name: 'access_control_list'
	AccessControlList []ExperimentAccessControlResponse `json:"access_control_list,omitempty"`

	// Wire name: 'object_id'
	ObjectId string `json:"object_id,omitempty"`

	// Wire name: 'object_type'
	ObjectType string `json:"object_type,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentPermissionsDescription struct {

	// Wire name: 'description'
	Description string `json:"description,omitempty"`
	// Permission level
	// Wire name: 'permission_level'
	PermissionLevel ExperimentPermissionLevel `json:"permission_level,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentPermissionsRequest struct {

	// Wire name: 'access_control_list'
	AccessControlList []ExperimentAccessControlRequest `json:"access_control_list,omitempty"`
	// The experiment for which to get or manage permissions.
	ExperimentId string `json:"-" tf:"-"`
}

type ExperimentTag struct {
	// The tag key.
	// Wire name: 'key'
	Key string `json:"key,omitempty"`
	// The tag value.
	// Wire name: 'value'
	Value string `json:"value,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ExperimentsAPI struct {
	// contains filtered or unexported fields
}

type ExperimentsInterface interface {

	// Creates an experiment with a name. Returns the ID of the newly created
	// experiment. Validates that another experiment with the same name does not
	// already exist and fails if another experiment with the same name already
	// exists.
	//
	// Throws `RESOURCE_ALREADY_EXISTS` if an experiment with the given name exists.
	CreateExperiment(ctx context.Context, request CreateExperiment) (*CreateExperimentResponse, error)

	// Create a logged model.
	CreateLoggedModel(ctx context.Context, request CreateLoggedModelRequest) (*CreateLoggedModelResponse, error)

	// Creates a new run within an experiment. A run is usually a single execution
	// of a machine learning or data ETL pipeline. MLflow uses runs to track the
	// `mlflowParam`, `mlflowMetric`, and `mlflowRunTag` associated with a single
	// execution.
	CreateRun(ctx context.Context, request CreateRun) (*CreateRunResponse, error)

	// Marks an experiment and associated metadata, runs, metrics, params, and tags
	// for deletion. If the experiment uses FileStore, artifacts associated with the
	// experiment are also deleted.
	DeleteExperiment(ctx context.Context, request DeleteExperiment) error

	// Delete a logged model.
	DeleteLoggedModel(ctx context.Context, request DeleteLoggedModelRequest) error

	// Delete a logged model.
	DeleteLoggedModelByModelId(ctx context.Context, modelId string) error

	// Delete a tag on a logged model.
	DeleteLoggedModelTag(ctx context.Context, request DeleteLoggedModelTagRequest) error

	// Delete a tag on a logged model.
	DeleteLoggedModelTagByModelIdAndTagKey(ctx context.Context, modelId string, tagKey string) error

	// Marks a run for deletion.
	DeleteRun(ctx context.Context, request DeleteRun) error

	// Bulk delete runs in an experiment that were created prior to or at the
	// specified timestamp. Deletes at most max_runs per request. To call this API
	// from a Databricks Notebook in Python, you can use the client code snippet on
	DeleteRuns(ctx context.Context, request DeleteRuns) (*DeleteRunsResponse, error)

	// Deletes a tag on a run. Tags are run metadata that can be updated during a
	// run and after a run completes.
	DeleteTag(ctx context.Context, request DeleteTag) error

	// Finalize a logged model.
	FinalizeLoggedModel(ctx context.Context, request FinalizeLoggedModelRequest) (*FinalizeLoggedModelResponse, error)

	// Gets metadata for an experiment.
	//
	// This endpoint will return deleted experiments, but prefers the active
	// experiment if an active and deleted experiment share the same name. If
	// multiple deleted experiments share the same name, the API will return one of
	// them.
	//
	// Throws `RESOURCE_DOES_NOT_EXIST` if no experiment with the specified name
	// exists.
	GetByName(ctx context.Context, request GetByNameRequest) (*GetExperimentByNameResponse, error)

	// Gets metadata for an experiment. This method works on deleted experiments.
	GetExperiment(ctx context.Context, request GetExperimentRequest) (*GetExperimentResponse, error)

	// Gets a list of all values for the specified metric for a given run.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetHistory(ctx context.Context, request GetHistoryRequest) listing.Iterator[Metric]

	// Gets a list of all values for the specified metric for a given run.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetHistoryAll(ctx context.Context, request GetHistoryRequest) ([]Metric, error)

	// Get a logged model.
	GetLoggedModel(ctx context.Context, request GetLoggedModelRequest) (*GetLoggedModelResponse, error)

	// Get a logged model.
	GetLoggedModelByModelId(ctx context.Context, modelId string) (*GetLoggedModelResponse, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevels(ctx context.Context, request GetExperimentPermissionLevelsRequest) (*GetExperimentPermissionLevelsResponse, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevelsByExperimentId(ctx context.Context, experimentId string) (*GetExperimentPermissionLevelsResponse, error)

	// Gets the permissions of an experiment. Experiments can inherit permissions
	// from their root object.
	GetPermissions(ctx context.Context, request GetExperimentPermissionsRequest) (*ExperimentPermissions, error)

	// Gets the permissions of an experiment. Experiments can inherit permissions
	// from their root object.
	GetPermissionsByExperimentId(ctx context.Context, experimentId string) (*ExperimentPermissions, error)

	// Gets the metadata, metrics, params, and tags for a run. In the case where
	// multiple metrics with the same key are logged for a run, return only the
	// value with the latest timestamp.
	//
	// If there are multiple values with the latest timestamp, return the maximum of
	// these values.
	GetRun(ctx context.Context, request GetRunRequest) (*GetRunResponse, error)

	// List artifacts for a run. Takes an optional `artifact_path` prefix which if
	// specified, the response contains only artifacts with the specified prefix. A
	// maximum of 1000 artifacts will be retrieved for UC Volumes. Please call
	// `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC
	// Volumes, which supports pagination. See [List directory contents | Files
	// API](/api/workspace/files/listdirectorycontents).
	//
	// This method is generated by Databricks SDK Code Generator.
	ListArtifacts(ctx context.Context, request ListArtifactsRequest) listing.Iterator[FileInfo]

	// List artifacts for a run. Takes an optional `artifact_path` prefix which if
	// specified, the response contains only artifacts with the specified prefix. A
	// maximum of 1000 artifacts will be retrieved for UC Volumes. Please call
	// `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC
	// Volumes, which supports pagination. See [List directory contents | Files
	// API](/api/workspace/files/listdirectorycontents).
	//
	// This method is generated by Databricks SDK Code Generator.
	ListArtifactsAll(ctx context.Context, request ListArtifactsRequest) ([]FileInfo, error)

	// Gets a list of all experiments.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExperiments(ctx context.Context, request ListExperimentsRequest) listing.Iterator[Experiment]

	// Gets a list of all experiments.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExperimentsAll(ctx context.Context, request ListExperimentsRequest) ([]Experiment, error)

	// Logs a batch of metrics, params, and tags for a run. If any data failed to be
	// persisted, the server will respond with an error (non-200 status code).
	//
	// In case of error (due to internal server error or an invalid request),
	// partial data may be written.
	//
	// You can write metrics, params, and tags in interleaving fashion, but within a
	// given entity type are guaranteed to follow the order specified in the request
	// body.
	//
	// The overwrite behavior for metrics, params, and tags is as follows:
	//
	// * Metrics: metric values are never overwritten. Logging a metric (key, value,
	// timestamp) appends to the set of values for the metric with the provided key.
	//
	// * Tags: tag values can be overwritten by successive writes to the same tag
	// key. That is, if multiple tag values with the same key are provided in the
	// same API request, the last-provided tag value is written. Logging the same
	// tag (key, value) is permitted. Specifically, logging a tag is idempotent.
	//
	// * Parameters: once written, param values cannot be changed (attempting to
	// overwrite a param value will result in an error). However, logging the same
	// param (key, value) is permitted. Specifically, logging a param is idempotent.
	//
	// Request Limits ------------------------------- A single JSON-serialized API
	// request may be up to 1 MB in size and contain:
	//
	// * No more than 1000 metrics, params, and tags in total
	//
	// * Up to 1000 metrics
	//
	// * Up to 100 params
	//
	// * Up to 100 tags
	//
	// For example, a valid request might contain 900 metrics, 50 params, and 50
	// tags, but logging 900 metrics, 50 params, and 51 tags is invalid.
	//
	// The following limits also apply to metric, param, and tag keys and values:
	//
	// * Metric keys, param keys, and tag keys can be up to 250 characters in length
	//
	// * Parameter and tag values can be up to 250 characters in length
	LogBatch(ctx context.Context, request LogBatch) error

	// Logs inputs, such as datasets and models, to an MLflow Run.
	LogInputs(ctx context.Context, request LogInputs) error

	// Logs params for a logged model. A param is a key-value pair (string key,
	// string value). Examples include hyperparameters used for ML model training. A
	// param can be logged only once for a logged model, and attempting to overwrite
	// an existing param with a different value will result in an error
	LogLoggedModelParams(ctx context.Context, request LogLoggedModelParamsRequest) error

	// Log a metric for a run. A metric is a key-value pair (string key, float
	// value) with an associated timestamp. Examples include the various metrics
	// that represent ML model accuracy. A metric can be logged multiple times.
	LogMetric(ctx context.Context, request LogMetric) error

	// **Note:** the [Create a logged
	// model](/api/workspace/experiments/createloggedmodel) API replaces this
	// endpoint.
	//
	// Log a model to an MLflow Run.
	LogModel(ctx context.Context, request LogModel) error

	// Logs outputs, such as models, from an MLflow Run.
	LogOutputs(ctx context.Context, request LogOutputsRequest) error

	// Logs a param used for a run. A param is a key-value pair (string key, string
	// value). Examples include hyperparameters used for ML model training and
	// constant dates and values used in an ETL pipeline. A param can be logged only
	// once for a run.
	LogParam(ctx context.Context, request LogParam) error

	// Restore an experiment marked for deletion. This also restores associated
	// metadata, runs, metrics, params, and tags. If experiment uses FileStore,
	// underlying artifacts associated with experiment are also restored.
	//
	// Throws `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was
	// permanently deleted.
	RestoreExperiment(ctx context.Context, request RestoreExperiment) error

	// Restores a deleted run. This also restores associated metadata, runs,
	// metrics, params, and tags.
	//
	// Throws `RESOURCE_DOES_NOT_EXIST` if the run was never created or was
	// permanently deleted.
	RestoreRun(ctx context.Context, request RestoreRun) error

	// Bulk restore runs in an experiment that were deleted no earlier than the
	// specified timestamp. Restores at most max_runs per request. To call this API
	// from a Databricks Notebook in Python, you can use the client code snippet on
	RestoreRuns(ctx context.Context, request RestoreRuns) (*RestoreRunsResponse, error)

	// Searches for experiments that satisfy specified search criteria.
	//
	// This method is generated by Databricks SDK Code Generator.
	SearchExperiments(ctx context.Context, request SearchExperiments) listing.Iterator[Experiment]

	// Searches for experiments that satisfy specified search criteria.
	//
	// This method is generated by Databricks SDK Code Generator.
	SearchExperimentsAll(ctx context.Context, request SearchExperiments) ([]Experiment, error)

	// Search for Logged Models that satisfy specified search criteria.
	SearchLoggedModels(ctx context.Context, request SearchLoggedModelsRequest) (*SearchLoggedModelsResponse, error)

	// Searches for runs that satisfy expressions.
	//
	// Search expressions can use `mlflowMetric` and `mlflowParam` keys.
	//
	// This method is generated by Databricks SDK Code Generator.
	SearchRuns(ctx context.Context, request SearchRuns) listing.Iterator[Run]

	// Searches for runs that satisfy expressions.
	//
	// Search expressions can use `mlflowMetric` and `mlflowParam` keys.
	//
	// This method is generated by Databricks SDK Code Generator.
	SearchRunsAll(ctx context.Context, request SearchRuns) ([]Run, error)

	// Sets a tag on an experiment. Experiment tags are metadata that can be
	// updated.
	SetExperimentTag(ctx context.Context, request SetExperimentTag) error

	// Set tags for a logged model.
	SetLoggedModelTags(ctx context.Context, request SetLoggedModelTagsRequest) error

	// Sets permissions on an object, replacing existing permissions if they exist.
	// Deletes all direct permissions if none are specified. Objects can inherit
	// permissions from their root object.
	SetPermissions(ctx context.Context, request ExperimentPermissionsRequest) (*ExperimentPermissions, error)

	// Sets a tag on a run. Tags are run metadata that can be updated during a run
	// and after a run completes.
	SetTag(ctx context.Context, request SetTag) error

	// Updates experiment metadata.
	UpdateExperiment(ctx context.Context, request UpdateExperiment) error

	// Updates the permissions on an experiment. Experiments can inherit permissions
	// from their root object.
	UpdatePermissions(ctx context.Context, request ExperimentPermissionsRequest) (*ExperimentPermissions, error)

	// Updates run metadata.
	UpdateRun(ctx context.Context, request UpdateRun) (*UpdateRunResponse, error)
}

type FeatureStoreAPI struct {
	// contains filtered or unexported fields
}

type FeatureStoreInterface interface {

	// Create an Online Feature Store.
	CreateOnlineStore(ctx context.Context, request CreateOnlineStoreRequest) (*OnlineStore, error)

	// Delete an Online Feature Store.
	DeleteOnlineStore(ctx context.Context, request DeleteOnlineStoreRequest) error

	// Delete an Online Feature Store.
	DeleteOnlineStoreByName(ctx context.Context, name string) error

	// Get an Online Feature Store.
	GetOnlineStore(ctx context.Context, request GetOnlineStoreRequest) (*OnlineStore, error)

	// Get an Online Feature Store.
	GetOnlineStoreByName(ctx context.Context, name string) (*OnlineStore, error)

	// List Online Feature Stores.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListOnlineStores(ctx context.Context, request ListOnlineStoresRequest) listing.Iterator[OnlineStore]

	// List Online Feature Stores.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListOnlineStoresAll(ctx context.Context, request ListOnlineStoresRequest) ([]OnlineStore, error)

	// Publish features.
	PublishTable(ctx context.Context, request PublishTableRequest) (*PublishTableResponse, error)

	// Update an Online Feature Store.
	UpdateOnlineStore(ctx context.Context, request UpdateOnlineStoreRequest) (*OnlineStore, error)
}

type FileInfo struct {
	// The size in bytes of the file. Unset for directories.
	// Wire name: 'file_size'
	FileSize int64 `json:"file_size,omitempty"`
	// Whether the path is a directory.
	// Wire name: 'is_dir'
	IsDir bool `json:"is_dir,omitempty"`
	// The path relative to the root artifact directory run.
	// Wire name: 'path'
	Path string `json:"path,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type FinalizeLoggedModelRequest struct {
	// The ID of the logged model to finalize.
	ModelId string `json:"-" tf:"-"`
	// Whether or not the model is ready for use.
	// “"LOGGED_MODEL_UPLOAD_FAILED"“ indicates that something went wrong when
	// logging the model weights / agent code.
	// Wire name: 'status'
	Status LoggedModelStatus `json:"status"`
}

type FinalizeLoggedModelResponse struct {
	// The updated logged model.
	// Wire name: 'model'
	Model *LoggedModel `json:"model,omitempty"`
}

type ForecastingAPI struct {
	// contains filtered or unexported fields
}

type ForecastingExperiment struct {
	// The unique ID for the forecasting experiment.
	// Wire name: 'experiment_id'
	ExperimentId string `json:"experiment_id,omitempty"`
	// The URL to the forecasting experiment page.
	// Wire name: 'experiment_page_url'
	ExperimentPageUrl string `json:"experiment_page_url,omitempty"`
	// The current state of the forecasting experiment.
	// Wire name: 'state'
	State ForecastingExperimentState `json:"state,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

type ForecastingExperimentState string

type ForecastingInterface interface {

	// WaitGetExperimentForecastingSucceeded repeatedly calls [ForecastingAPI.GetExperiment] and waits to reach SUCCEEDED state
	WaitGetExperimentForecastingSucceeded(ctx context.Context, experimentId string,
		timeout time.Duration, callback func(*ForecastingExperiment)) (*ForecastingExperiment, error)

	// Creates a serverless forecasting experiment. Returns the experiment ID.
	CreateExperiment(ctx context.Context, createForecastingExperimentRequest CreateForecastingExperimentRequest) (*WaitGetExperimentForecastingSucceeded[CreateForecastingExperimentResponse], error)

	// Calls [ForecastingAPIInterface.CreateExperiment] and waits to reach SUCCEEDED state
	//
	// You can override the default timeout of 120 minutes by calling adding
	// retries.Timeout[ForecastingExperiment](60*time.Minute) functional option.
	//
	// Deprecated: use [ForecastingAPIInterface.CreateExperiment].Get() or [ForecastingAPIInterface.WaitGetExperimentForecastingSucceeded]
	CreateExperimentAndWait(ctx context.Context, createForecastingExperimentRequest CreateForecastingExperimentRequest, options ...retries.Option[ForecastingExperiment]) (*ForecastingExperiment, error)

	// Public RPC to get forecasting experiment
	GetExperiment(ctx context.Context, request GetForecastingExperimentRequest) (*ForecastingExperiment, error)

	// Public RPC to get forecasting experiment
	GetExperimentByExperimentId(ctx context.Context, experimentId string) (*ForecastingExperiment, error)
}