Documentation ¶
Index ¶
- type Activity
- type ApproveTransitionRequest
- type ApproveTransitionRequestResponse
- type CommentObject
- type CreateComment
- type CreateCommentResponse
- type CreateExperiment
- type CreateExperimentResponse
- type CreateModelRequest
- type CreateModelResponse
- type CreateModelVersionRequest
- type CreateModelVersionResponse
- type CreateRegistryWebhook
- type CreateRun
- type CreateRunResponse
- type CreateTransitionRequest
- type CreateTransitionRequestResponse
- type CreateWebhookResponse
- type Dataset
- type DatasetInput
- type DeleteCommentRequest
- type DeleteCommentResponse
- type DeleteExperiment
- type DeleteExperimentResponse
- type DeleteModelRequest
- type DeleteModelResponse
- type DeleteModelTagRequest
- type DeleteModelTagResponse
- type DeleteModelVersionRequest
- type DeleteModelVersionResponse
- type DeleteModelVersionTagRequest
- type DeleteModelVersionTagResponse
- type DeleteRun
- type DeleteRunResponse
- type DeleteRuns
- type DeleteRunsResponse
- type DeleteTag
- type DeleteTagResponse
- type DeleteTransitionRequestRequest
- type DeleteTransitionRequestResponse
- type DeleteWebhookRequest
- type DeleteWebhookResponse
- type Experiment
- type ExperimentAccessControlRequest
- type ExperimentAccessControlResponse
- type ExperimentPermission
- type ExperimentPermissions
- type ExperimentPermissionsDescription
- type ExperimentPermissionsRequest
- type ExperimentTag
- type FileInfo
- type GetByNameRequest
- type GetExperimentPermissionLevelsRequest
- type GetExperimentPermissionLevelsResponse
- type GetExperimentPermissionsRequest
- type GetExperimentRequest
- type GetExperimentResponse
- type GetHistoryRequest
- type GetLatestVersionsRequest
- type GetLatestVersionsResponse
- type GetMetricHistoryResponse
- type GetModelRequest
- type GetModelResponse
- type GetModelVersionDownloadUriRequest
- type GetModelVersionDownloadUriResponse
- type GetModelVersionRequest
- type GetModelVersionResponse
- type GetRegisteredModelPermissionLevelsRequest
- type GetRegisteredModelPermissionLevelsResponse
- type GetRegisteredModelPermissionsRequest
- type GetRunRequest
- type GetRunResponse
- type HttpUrlSpec
- type HttpUrlSpecWithoutSecret
- type InputTag
- type JobSpec
- type JobSpecWithoutSecret
- type ListArtifactsRequest
- type ListArtifactsResponse
- type ListExperimentsRequest
- type ListExperimentsResponse
- type ListModelsRequest
- type ListModelsResponse
- type ListRegistryWebhooks
- type ListTransitionRequestsRequest
- type ListTransitionRequestsResponse
- type ListWebhooksRequest
- type LogBatch
- type LogBatchResponse
- type LogInputs
- type LogInputsResponse
- type LogMetric
- type LogMetricResponse
- type LogModel
- type LogModelResponse
- type LogParam
- type LogParamResponse
- type Metric
- type Model
- type ModelDatabricks
- type ModelTag
- type ModelVersion
- type ModelVersionDatabricks
- type ModelVersionTag
- type Param
- type RegisteredModelAccessControlRequest
- type RegisteredModelAccessControlResponse
- type RegisteredModelPermission
- type RegisteredModelPermissions
- type RegisteredModelPermissionsDescription
- type RegisteredModelPermissionsRequest
- type RegistryWebhook
- type RejectTransitionRequest
- type RejectTransitionRequestResponse
- type RenameModelRequest
- type RenameModelResponse
- type RestoreExperiment
- type RestoreExperimentResponse
- type RestoreRun
- type RestoreRunResponse
- type RestoreRuns
- type RestoreRunsResponse
- type Run
- type RunData
- type RunInfo
- type RunInputs
- type RunTag
- type SearchExperiments
- type SearchExperimentsResponse
- type SearchModelVersionsRequest
- type SearchModelVersionsResponse
- type SearchModelsRequest
- type SearchModelsResponse
- type SearchRuns
- type SearchRunsResponse
- type SetExperimentTag
- type SetExperimentTagResponse
- type SetModelTagRequest
- type SetModelTagResponse
- type SetModelVersionTagRequest
- type SetModelVersionTagResponse
- type SetTag
- type SetTagResponse
- type TestRegistryWebhook
- type TestRegistryWebhookRequest
- type TestRegistryWebhookResponse
- type TransitionModelVersionStageDatabricks
- type TransitionRequest
- type TransitionStageResponse
- type UpdateComment
- type UpdateCommentResponse
- type UpdateExperiment
- type UpdateExperimentResponse
- type UpdateModelRequest
- type UpdateModelResponse
- type UpdateModelVersionRequest
- type UpdateModelVersionResponse
- type UpdateRegistryWebhook
- type UpdateRun
- type UpdateRunResponse
- type UpdateWebhookResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Activity ¶
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. ActivityType types.String `tfsdk:"activity_type" tf:"optional"` // User-provided comment associated with the activity. Comment types.String `tfsdk:"comment" tf:"optional"` // Creation time of the object, as a Unix timestamp in milliseconds. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // 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. FromStage types.String `tfsdk:"from_stage" tf:"optional"` // Unique identifier for the object. Id types.String `tfsdk:"id" tf:"optional"` // Time of the object at last update, as a Unix timestamp in milliseconds. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // 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. SystemComment types.String `tfsdk:"system_comment" tf:"optional"` // 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. ToStage types.String `tfsdk:"to_stage" tf:"optional"` // The username of the user that created the object. UserId types.String `tfsdk:"user_id" tf:"optional"` }
Activity recorded for the action.
type ApproveTransitionRequest ¶
type ApproveTransitionRequest struct { // Specifies whether to archive all current model versions in the target // stage. ArchiveExistingVersions types.Bool `tfsdk:"archive_existing_versions" tf:""` // User-provided comment on the action. Comment types.String `tfsdk:"comment" tf:"optional"` // Name of the model. Name types.String `tfsdk:"name" tf:""` // 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. Stage types.String `tfsdk:"stage" tf:""` // Version of the model. Version types.String `tfsdk:"version" tf:""` }
type ApproveTransitionRequestResponse ¶
type ApproveTransitionRequestResponse struct { // Activity recorded for the action. Activity *Activity `tfsdk:"activity" tf:"optional"` }
type CommentObject ¶
type CommentObject struct { // Array of actions on the activity allowed for the current viewer. AvailableActions []types.String `tfsdk:"available_actions" tf:"optional"` // User-provided comment on the action. Comment types.String `tfsdk:"comment" tf:"optional"` // Creation time of the object, as a Unix timestamp in milliseconds. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // Comment ID Id types.String `tfsdk:"id" tf:"optional"` // Time of the object at last update, as a Unix timestamp in milliseconds. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // The username of the user that created the object. UserId types.String `tfsdk:"user_id" tf:"optional"` }
Comment details.
type CreateComment ¶
type CreateCommentResponse ¶
type CreateCommentResponse struct { // Comment details. Comment *CommentObject `tfsdk:"comment" tf:"optional"` }
type CreateExperiment ¶
type CreateExperiment struct { // Location where all artifacts for the experiment are stored. If not // provided, the remote server will select an appropriate default. ArtifactLocation types.String `tfsdk:"artifact_location" tf:"optional"` // Experiment name. Name types.String `tfsdk:"name" tf:""` // 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. Tags []ExperimentTag `tfsdk:"tags" tf:"optional"` }
type CreateModelRequest ¶
type CreateModelRequest struct { // Optional description for registered model. Description types.String `tfsdk:"description" tf:"optional"` // Register models under this name Name types.String `tfsdk:"name" tf:""` // Additional metadata for registered model. Tags []ModelTag `tfsdk:"tags" tf:"optional"` }
type CreateModelResponse ¶
type CreateModelResponse struct {
RegisteredModel *Model `tfsdk:"registered_model" tf:"optional"`
}
type CreateModelVersionRequest ¶
type CreateModelVersionRequest struct { // Optional description for model version. Description types.String `tfsdk:"description" tf:"optional"` // Register model under this name Name types.String `tfsdk:"name" tf:""` // MLflow run ID for correlation, if `source` was generated by an experiment // run in MLflow tracking server RunId types.String `tfsdk:"run_id" tf:"optional"` // MLflow run link - this is the exact link of the run that generated this // model version, potentially hosted at another instance of MLflow. RunLink types.String `tfsdk:"run_link" tf:"optional"` // URI indicating the location of the model artifacts. Source types.String `tfsdk:"source" tf:""` // Additional metadata for model version. Tags []ModelVersionTag `tfsdk:"tags" tf:"optional"` }
type CreateModelVersionResponse ¶
type CreateModelVersionResponse struct { // Return new version number generated for this model in registry. ModelVersion *ModelVersion `tfsdk:"model_version" tf:"optional"` }
type CreateRegistryWebhook ¶
type CreateRegistryWebhook struct { // User-specified description for the webhook. Description types.String `tfsdk:"description" tf:"optional"` // 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. Events []types.String `tfsdk:"events" tf:""` HttpUrlSpec *HttpUrlSpec `tfsdk:"http_url_spec" tf:"optional"` JobSpec *JobSpec `tfsdk:"job_spec" tf:"optional"` // Name of the model whose events would trigger this webhook. ModelName types.String `tfsdk:"model_name" tf:"optional"` // 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. Status types.String `tfsdk:"status" tf:"optional"` }
type CreateRun ¶
type CreateRun struct { // ID of the associated experiment. ExperimentId types.String `tfsdk:"experiment_id" tf:"optional"` // Unix timestamp in milliseconds of when the run started. StartTime types.Int64 `tfsdk:"start_time" tf:"optional"` // Additional metadata for run. Tags []RunTag `tfsdk:"tags" tf:"optional"` // 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. UserId types.String `tfsdk:"user_id" tf:"optional"` }
type CreateRunResponse ¶
type CreateRunResponse struct { // The newly created run. Run *Run `tfsdk:"run" tf:"optional"` }
type CreateTransitionRequest ¶
type CreateTransitionRequest struct { // User-provided comment on the action. Comment types.String `tfsdk:"comment" tf:"optional"` // Name of the model. Name types.String `tfsdk:"name" tf:""` // 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. Stage types.String `tfsdk:"stage" tf:""` // Version of the model. Version types.String `tfsdk:"version" tf:""` }
type CreateTransitionRequestResponse ¶
type CreateTransitionRequestResponse struct { // Transition request details. Request *TransitionRequest `tfsdk:"request" tf:"optional"` }
type CreateWebhookResponse ¶
type CreateWebhookResponse struct {
Webhook *RegistryWebhook `tfsdk:"webhook" tf:"optional"`
}
type Dataset ¶
type Dataset struct { // Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies // it within datasets of the same name. Digest types.String `tfsdk:"digest" tf:"optional"` // The name of the dataset. E.g. “my.uc.table@2” “nyc-taxi-dataset”, // “fantastic-elk-3” Name types.String `tfsdk:"name" tf:"optional"` // 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. Profile types.String `tfsdk:"profile" tf:"optional"` // The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe, // MLflow TensorSpec JSON for an ndarray, or another schema format. Schema types.String `tfsdk:"schema" tf:"optional"` // The type of the dataset source, e.g. ‘databricks-uc-table’, // ‘DBFS’, ‘S3’, ... Source types.String `tfsdk:"source" tf:"optional"` // Source information for the dataset. Note that the source may not exactly // reproduce the dataset if it was transformed / modified before use with // MLflow. SourceType types.String `tfsdk:"source_type" tf:"optional"` }
type DatasetInput ¶
type DeleteCommentRequest ¶
Delete a comment
type DeleteCommentResponse ¶
type DeleteCommentResponse struct { }
type DeleteExperiment ¶
type DeleteExperimentResponse ¶
type DeleteExperimentResponse struct { }
type DeleteModelRequest ¶
type DeleteModelRequest struct { // Registered model unique name identifier. Name types.String `tfsdk:"-"` }
Delete a model
type DeleteModelResponse ¶
type DeleteModelResponse struct { }
type DeleteModelTagRequest ¶
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 types.String `tfsdk:"-"` // Name of the registered model that the tag was logged under. Name types.String `tfsdk:"-"` }
Delete a model tag
type DeleteModelTagResponse ¶
type DeleteModelTagResponse struct { }
type DeleteModelVersionRequest ¶
type DeleteModelVersionRequest struct { // Name of the registered model Name types.String `tfsdk:"-"` // Model version number Version types.String `tfsdk:"-"` }
Delete a model version.
type DeleteModelVersionResponse ¶
type DeleteModelVersionResponse struct { }
type DeleteModelVersionTagRequest ¶
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 types.String `tfsdk:"-"` // Name of the registered model that the tag was logged under. Name types.String `tfsdk:"-"` // Model version number that the tag was logged under. Version types.String `tfsdk:"-"` }
Delete a model version tag
type DeleteModelVersionTagResponse ¶
type DeleteModelVersionTagResponse struct { }
type DeleteRunResponse ¶
type DeleteRunResponse struct { }
type DeleteRuns ¶
type DeleteRuns struct { // The ID of the experiment containing the runs to delete. ExperimentId types.String `tfsdk:"experiment_id" tf:""` // An optional positive integer indicating the maximum number of runs to // delete. The maximum allowed value for max_runs is 10000. MaxRuns types.Int64 `tfsdk:"max_runs" tf:"optional"` // The maximum creation timestamp in milliseconds since the UNIX epoch for // deleting runs. Only runs created prior to or at this timestamp are // deleted. MaxTimestampMillis types.Int64 `tfsdk:"max_timestamp_millis" tf:""` }
type DeleteRunsResponse ¶
type DeleteTagResponse ¶
type DeleteTagResponse struct { }
type DeleteTransitionRequestRequest ¶
type DeleteTransitionRequestRequest struct { // User-provided comment on the action. Comment types.String `tfsdk:"-"` // 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 types.String `tfsdk:"-"` // Name of the model. Name types.String `tfsdk:"-"` // 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 types.String `tfsdk:"-"` // Version of the model. Version types.String `tfsdk:"-"` }
Delete a transition request
type DeleteTransitionRequestResponse ¶
type DeleteTransitionRequestResponse struct { }
type DeleteWebhookRequest ¶
type DeleteWebhookRequest struct { // Webhook ID required to delete a registry webhook. Id types.String `tfsdk:"-"` }
Delete a webhook
type DeleteWebhookResponse ¶
type DeleteWebhookResponse struct { }
type Experiment ¶
type Experiment struct { // Location where artifacts for the experiment are stored. ArtifactLocation types.String `tfsdk:"artifact_location" tf:"optional"` // Creation time CreationTime types.Int64 `tfsdk:"creation_time" tf:"optional"` // Unique identifier for the experiment. ExperimentId types.String `tfsdk:"experiment_id" tf:"optional"` // Last update time LastUpdateTime types.Int64 `tfsdk:"last_update_time" tf:"optional"` // Current life cycle stage of the experiment: "active" or "deleted". // Deleted experiments are not returned by APIs. LifecycleStage types.String `tfsdk:"lifecycle_stage" tf:"optional"` // Human readable name that identifies the experiment. Name types.String `tfsdk:"name" tf:"optional"` // Tags: Additional metadata key-value pairs. Tags []ExperimentTag `tfsdk:"tags" tf:"optional"` }
type ExperimentAccessControlRequest ¶
type ExperimentAccessControlRequest struct { // name of the group GroupName types.String `tfsdk:"group_name" tf:"optional"` // Permission level PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"` // application ID of a service principal ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"` // name of the user UserName types.String `tfsdk:"user_name" tf:"optional"` }
type ExperimentAccessControlResponse ¶
type ExperimentAccessControlResponse struct { // All permissions. AllPermissions []ExperimentPermission `tfsdk:"all_permissions" tf:"optional"` // Display name of the user or service principal. DisplayName types.String `tfsdk:"display_name" tf:"optional"` // name of the group GroupName types.String `tfsdk:"group_name" tf:"optional"` // Name of the service principal. ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"` // name of the user UserName types.String `tfsdk:"user_name" tf:"optional"` }
type ExperimentPermission ¶
type ExperimentPermissions ¶
type ExperimentPermissions struct { AccessControlList []ExperimentAccessControlResponse `tfsdk:"access_control_list" tf:"optional"` ObjectId types.String `tfsdk:"object_id" tf:"optional"` ObjectType types.String `tfsdk:"object_type" tf:"optional"` }
type ExperimentPermissionsRequest ¶
type ExperimentPermissionsRequest struct { AccessControlList []ExperimentAccessControlRequest `tfsdk:"access_control_list" tf:"optional"` // The experiment for which to get or manage permissions. ExperimentId types.String `tfsdk:"-"` }
type ExperimentTag ¶
type FileInfo ¶
type FileInfo struct { // Size in bytes. Unset for directories. FileSize types.Int64 `tfsdk:"file_size" tf:"optional"` // Whether the path is a directory. IsDir types.Bool `tfsdk:"is_dir" tf:"optional"` // Path relative to the root artifact directory run. Path types.String `tfsdk:"path" tf:"optional"` }
type GetByNameRequest ¶
type GetByNameRequest struct { // Name of the associated experiment. ExperimentName types.String `tfsdk:"-"` }
Get metadata
type GetExperimentPermissionLevelsRequest ¶
type GetExperimentPermissionLevelsRequest struct { // The experiment for which to get or manage permissions. ExperimentId types.String `tfsdk:"-"` }
Get experiment permission levels
type GetExperimentPermissionLevelsResponse ¶
type GetExperimentPermissionLevelsResponse struct { // Specific permission levels PermissionLevels []ExperimentPermissionsDescription `tfsdk:"permission_levels" tf:"optional"` }
type GetExperimentPermissionsRequest ¶
type GetExperimentPermissionsRequest struct { // The experiment for which to get or manage permissions. ExperimentId types.String `tfsdk:"-"` }
Get experiment permissions
type GetExperimentRequest ¶
type GetExperimentRequest struct { // ID of the associated experiment. ExperimentId types.String `tfsdk:"-"` }
Get an experiment
type GetExperimentResponse ¶
type GetExperimentResponse struct { // Experiment details. Experiment *Experiment `tfsdk:"experiment" tf:"optional"` }
type GetHistoryRequest ¶
type GetHistoryRequest struct { // Maximum number of Metric records to return per paginated request. Default // is set to 25,000. If set higher than 25,000, a request Exception will be // raised. MaxResults types.Int64 `tfsdk:"-"` // Name of the metric. MetricKey types.String `tfsdk:"-"` // Token indicating the page of metric histories to fetch. PageToken types.String `tfsdk:"-"` // ID of the run from which to fetch metric values. Must be provided. RunId types.String `tfsdk:"-"` // [Deprecated, use run_id instead] ID of the run from which to fetch metric // values. This field will be removed in a future MLflow version. RunUuid types.String `tfsdk:"-"` }
Get history of a given metric within a run
type GetLatestVersionsResponse ¶
type GetLatestVersionsResponse struct { // Latest version models for each requests stage. Only return models with // current `READY` status. If no `stages` provided, returns the latest // version for each stage, including `"None"`. ModelVersions []ModelVersion `tfsdk:"model_versions" tf:"optional"` }
type GetModelRequest ¶
type GetModelRequest struct { // Registered model unique name identifier. Name types.String `tfsdk:"-"` }
Get model
type GetModelResponse ¶
type GetModelResponse struct {
RegisteredModelDatabricks *ModelDatabricks `tfsdk:"registered_model_databricks" tf:"optional"`
}
type GetModelVersionDownloadUriRequest ¶
type GetModelVersionDownloadUriRequest struct { // Name of the registered model Name types.String `tfsdk:"-"` // Model version number Version types.String `tfsdk:"-"` }
Get a model version URI
type GetModelVersionRequest ¶
type GetModelVersionRequest struct { // Name of the registered model Name types.String `tfsdk:"-"` // Model version number Version types.String `tfsdk:"-"` }
Get a model version
type GetModelVersionResponse ¶
type GetModelVersionResponse struct {
ModelVersion *ModelVersion `tfsdk:"model_version" tf:"optional"`
}
type GetRegisteredModelPermissionLevelsRequest ¶
type GetRegisteredModelPermissionLevelsRequest struct { // The registered model for which to get or manage permissions. RegisteredModelId types.String `tfsdk:"-"` }
Get registered model permission levels
type GetRegisteredModelPermissionLevelsResponse ¶
type GetRegisteredModelPermissionLevelsResponse struct { // Specific permission levels PermissionLevels []RegisteredModelPermissionsDescription `tfsdk:"permission_levels" tf:"optional"` }
type GetRegisteredModelPermissionsRequest ¶
type GetRegisteredModelPermissionsRequest struct { // The registered model for which to get or manage permissions. RegisteredModelId types.String `tfsdk:"-"` }
Get registered model permissions
type GetRunRequest ¶
type GetRunRequest struct { // ID of the run to fetch. Must be provided. RunId types.String `tfsdk:"-"` // [Deprecated, use run_id instead] ID of the run to fetch. This field will // be removed in a future MLflow version. RunUuid types.String `tfsdk:"-"` }
Get a run
type GetRunResponse ¶
type GetRunResponse struct { // Run metadata (name, start time, etc) and data (metrics, params, and // tags). Run *Run `tfsdk:"run" tf:"optional"` }
type HttpUrlSpec ¶
type HttpUrlSpec struct { // Value of the authorization header that should be sent in the request sent // by the wehbook. It should be of the form `"<auth type> <credentials>"`. // If set to an empty string, no authorization header will be included in // the request. Authorization types.String `tfsdk:"authorization" tf:"optional"` // Enable/disable SSL certificate validation. Default is true. For // self-signed certificates, this field must be false AND the destination // server must disable certificate validation as well. For security // purposes, it is encouraged to perform secret validation with the // HMAC-encoded portion of the payload and acknowledge the risk associated // with disabling hostname validation whereby it becomes more likely that // requests can be maliciously routed to an unintended host. EnableSslVerification types.Bool `tfsdk:"enable_ssl_verification" tf:"optional"` // Shared secret required for HMAC encoding payload. The HMAC-encoded // payload will be sent in the header as: { "X-Databricks-Signature": // $encoded_payload }. Secret types.String `tfsdk:"secret" tf:"optional"` // External HTTPS URL called on event trigger (by using a POST request). Url types.String `tfsdk:"url" tf:""` }
type HttpUrlSpecWithoutSecret ¶
type HttpUrlSpecWithoutSecret struct { // Enable/disable SSL certificate validation. Default is true. For // self-signed certificates, this field must be false AND the destination // server must disable certificate validation as well. For security // purposes, it is encouraged to perform secret validation with the // HMAC-encoded portion of the payload and acknowledge the risk associated // with disabling hostname validation whereby it becomes more likely that // requests can be maliciously routed to an unintended host. EnableSslVerification types.Bool `tfsdk:"enable_ssl_verification" tf:"optional"` // External HTTPS URL called on event trigger (by using a POST request). Url types.String `tfsdk:"url" tf:"optional"` }
type JobSpec ¶
type JobSpec struct { // The personal access token used to authorize webhook's job runs. AccessToken types.String `tfsdk:"access_token" tf:""` // ID of the job that the webhook runs. JobId types.String `tfsdk:"job_id" tf:""` // URL of the workspace containing the job that this webhook runs. If not // specified, the job’s workspace URL is assumed to be the same as the // workspace where the webhook is created. WorkspaceUrl types.String `tfsdk:"workspace_url" tf:"optional"` }
type JobSpecWithoutSecret ¶
type JobSpecWithoutSecret struct { // ID of the job that the webhook runs. JobId types.String `tfsdk:"job_id" tf:"optional"` // URL of the workspace containing the job that this webhook runs. Defaults // to the workspace URL in which the webhook is created. If not specified, // the job’s workspace is assumed to be the same as the webhook’s. WorkspaceUrl types.String `tfsdk:"workspace_url" tf:"optional"` }
type ListArtifactsRequest ¶
type ListArtifactsRequest struct { // Token indicating the page of artifact results to fetch. `page_token` is // not supported when listing artifacts in UC Volumes. 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). PageToken types.String `tfsdk:"-"` // Filter artifacts matching this path (a relative path from the root // artifact directory). Path types.String `tfsdk:"-"` // ID of the run whose artifacts to list. Must be provided. RunId types.String `tfsdk:"-"` // [Deprecated, use run_id instead] ID of the run whose artifacts to list. // This field will be removed in a future MLflow version. RunUuid types.String `tfsdk:"-"` }
Get all artifacts
type ListArtifactsResponse ¶
type ListArtifactsResponse struct { // File location and metadata for artifacts. Files []FileInfo `tfsdk:"files" tf:"optional"` // Token that can be used to retrieve the next page of artifact results NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"` // Root artifact directory for the run. RootUri types.String `tfsdk:"root_uri" tf:"optional"` }
type ListExperimentsRequest ¶
type ListExperimentsRequest struct { // Maximum number of experiments desired. If `max_results` is unspecified, // return all experiments. If `max_results` is too large, it'll be // automatically capped at 1000. Callers of this endpoint are encouraged to // pass max_results explicitly and leverage page_token to iterate through // experiments. MaxResults types.Int64 `tfsdk:"-"` // Token indicating the page of experiments to fetch PageToken types.String `tfsdk:"-"` // Qualifier for type of experiments to be returned. If unspecified, return // only active experiments. ViewType types.String `tfsdk:"-"` }
List experiments
type ListExperimentsResponse ¶
type ListExperimentsResponse struct { // Paginated Experiments beginning with the first item on the requested // page. Experiments []Experiment `tfsdk:"experiments" tf:"optional"` // Token that can be used to retrieve the next page of experiments. Empty // token means no more experiment is available for retrieval. NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"` }
type ListModelsRequest ¶
type ListModelsRequest struct { // Maximum number of registered models desired. Max threshold is 1000. MaxResults types.Int64 `tfsdk:"-"` // Pagination token to go to the next page based on a previous query. PageToken types.String `tfsdk:"-"` }
List models
type ListModelsResponse ¶
type ListRegistryWebhooks ¶
type ListRegistryWebhooks struct { // Token that can be used to retrieve the next page of artifact results NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"` // Array of registry webhooks. Webhooks []RegistryWebhook `tfsdk:"webhooks" tf:"optional"` }
type ListTransitionRequestsRequest ¶
type ListTransitionRequestsRequest struct { // Name of the model. Name types.String `tfsdk:"-"` // Version of the model. Version types.String `tfsdk:"-"` }
List transition requests
type ListTransitionRequestsResponse ¶
type ListTransitionRequestsResponse struct { // Array of open transition requests. Requests []Activity `tfsdk:"requests" tf:"optional"` }
type ListWebhooksRequest ¶
type ListWebhooksRequest struct { // If `events` is specified, any webhook with one or more of the specified // trigger events is included in the output. If `events` is not specified, // webhooks of all event types are included in the output. Events []types.String `tfsdk:"-"` // If not specified, all webhooks associated with the specified events are // listed, regardless of their associated model. ModelName types.String `tfsdk:"-"` // Token indicating the page of artifact results to fetch PageToken types.String `tfsdk:"-"` }
List registry webhooks
type LogBatch ¶
type LogBatch struct { // Metrics to log. A single request can contain up to 1000 metrics, and up // to 1000 metrics, params, and tags in total. Metrics []Metric `tfsdk:"metrics" tf:"optional"` // Params to log. A single request can contain up to 100 params, and up to // 1000 metrics, params, and tags in total. Params []Param `tfsdk:"params" tf:"optional"` // ID of the run to log under RunId types.String `tfsdk:"run_id" tf:"optional"` // Tags to log. A single request can contain up to 100 tags, and up to 1000 // metrics, params, and tags in total. Tags []RunTag `tfsdk:"tags" tf:"optional"` }
type LogBatchResponse ¶
type LogBatchResponse struct { }
type LogInputs ¶
type LogInputs struct { // Dataset inputs Datasets []DatasetInput `tfsdk:"datasets" tf:"optional"` // ID of the run to log under RunId types.String `tfsdk:"run_id" tf:"optional"` }
type LogInputsResponse ¶
type LogInputsResponse struct { }
type LogMetric ¶
type LogMetric struct { // Name of the metric. Key types.String `tfsdk:"key" tf:""` // ID of the run under which to log the metric. Must be provided. RunId types.String `tfsdk:"run_id" tf:"optional"` // [Deprecated, use run_id instead] ID of the run under which to log the // metric. This field will be removed in a future MLflow version. RunUuid types.String `tfsdk:"run_uuid" tf:"optional"` // Step at which to log the metric Step types.Int64 `tfsdk:"step" tf:"optional"` // Unix timestamp in milliseconds at the time metric was logged. Timestamp types.Int64 `tfsdk:"timestamp" tf:""` // Double value of the metric being logged. Value types.Float64 `tfsdk:"value" tf:""` }
type LogMetricResponse ¶
type LogMetricResponse struct { }
type LogModelResponse ¶
type LogModelResponse struct { }
type LogParam ¶
type LogParam struct { // Name of the param. Maximum size is 255 bytes. Key types.String `tfsdk:"key" tf:""` // ID of the run under which to log the param. Must be provided. RunId types.String `tfsdk:"run_id" tf:"optional"` // [Deprecated, use run_id instead] ID of the run under which to log the // param. This field will be removed in a future MLflow version. RunUuid types.String `tfsdk:"run_uuid" tf:"optional"` // String value of the param being logged. Maximum size is 500 bytes. Value types.String `tfsdk:"value" tf:""` }
type LogParamResponse ¶
type LogParamResponse struct { }
type Metric ¶
type Metric struct { // Key identifying this metric. Key types.String `tfsdk:"key" tf:"optional"` // Step at which to log the metric. Step types.Int64 `tfsdk:"step" tf:"optional"` // The timestamp at which this metric was recorded. Timestamp types.Int64 `tfsdk:"timestamp" tf:"optional"` // Value associated with this metric. Value types.Float64 `tfsdk:"value" tf:"optional"` }
type Model ¶
type Model struct { // Timestamp recorded when this `registered_model` was created. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // Description of this `registered_model`. Description types.String `tfsdk:"description" tf:"optional"` // Timestamp recorded when metadata for this `registered_model` was last // updated. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // Collection of latest model versions for each stage. Only contains models // with current `READY` status. LatestVersions []ModelVersion `tfsdk:"latest_versions" tf:"optional"` // Unique name for the model. Name types.String `tfsdk:"name" tf:"optional"` // Tags: Additional metadata key-value pairs for this `registered_model`. Tags []ModelTag `tfsdk:"tags" tf:"optional"` // User that created this `registered_model` UserId types.String `tfsdk:"user_id" tf:"optional"` }
type ModelDatabricks ¶
type ModelDatabricks struct { // Creation time of the object, as a Unix timestamp in milliseconds. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // User-specified description for the object. Description types.String `tfsdk:"description" tf:"optional"` // Unique identifier for the object. Id types.String `tfsdk:"id" tf:"optional"` // Time of the object at last update, as a Unix timestamp in milliseconds. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // Array of model versions, each the latest version for its stage. LatestVersions []ModelVersion `tfsdk:"latest_versions" tf:"optional"` // Name of the model. Name types.String `tfsdk:"name" tf:"optional"` // Permission level of the requesting user on the object. For what is // allowed at each level, see [MLflow Model permissions](..). PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"` // Array of tags associated with the model. Tags []ModelTag `tfsdk:"tags" tf:"optional"` // The username of the user that created the object. UserId types.String `tfsdk:"user_id" tf:"optional"` }
type ModelVersion ¶
type ModelVersion struct { // Timestamp recorded when this `model_version` was created. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // Current stage for this `model_version`. CurrentStage types.String `tfsdk:"current_stage" tf:"optional"` // Description of this `model_version`. Description types.String `tfsdk:"description" tf:"optional"` // Timestamp recorded when metadata for this `model_version` was last // updated. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // Unique name of the model Name types.String `tfsdk:"name" tf:"optional"` // MLflow run ID used when creating `model_version`, if `source` was // generated by an experiment run stored in MLflow tracking server. RunId types.String `tfsdk:"run_id" tf:"optional"` // Run Link: Direct link to the run that generated this version RunLink types.String `tfsdk:"run_link" tf:"optional"` // URI indicating the location of the source model artifacts, used when // creating `model_version` Source types.String `tfsdk:"source" tf:"optional"` // Current status of `model_version` Status types.String `tfsdk:"status" tf:"optional"` // Details on current `status`, if it is pending or failed. StatusMessage types.String `tfsdk:"status_message" tf:"optional"` // Tags: Additional metadata key-value pairs for this `model_version`. Tags []ModelVersionTag `tfsdk:"tags" tf:"optional"` // User that created this `model_version`. UserId types.String `tfsdk:"user_id" tf:"optional"` // Model's version number. Version types.String `tfsdk:"version" tf:"optional"` }
type ModelVersionDatabricks ¶
type ModelVersionDatabricks struct { // Creation time of the object, as a Unix timestamp in milliseconds. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // Stage of the model version. Valid values are: // // * `None`: The initial stage of a model version. // // * `Staging`: Staging or pre-production stage. // // * `Production`: Production stage. // // * `Archived`: Archived stage. CurrentStage types.String `tfsdk:"current_stage" tf:"optional"` // User-specified description for the object. Description types.String `tfsdk:"description" tf:"optional"` // Time of the object at last update, as a Unix timestamp in milliseconds. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // Name of the model. Name types.String `tfsdk:"name" tf:"optional"` // Permission level of the requesting user on the object. For what is // allowed at each level, see [MLflow Model permissions](..). PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"` // Unique identifier for the MLflow tracking run associated with the source // model artifacts. RunId types.String `tfsdk:"run_id" tf:"optional"` // URL of the run associated with the model artifacts. This field is set at // model version creation time only for model versions whose source run is // from a tracking server that is different from the registry server. RunLink types.String `tfsdk:"run_link" tf:"optional"` // URI that indicates the location of the source model artifacts. This is // used when creating the model version. Source types.String `tfsdk:"source" tf:"optional"` // The status of the model version. Valid values are: * // `PENDING_REGISTRATION`: Request to register a new model version is // pending as server performs background tasks. // // * `FAILED_REGISTRATION`: Request to register a new model version has // failed. // // * `READY`: Model version is ready for use. Status types.String `tfsdk:"status" tf:"optional"` // Details on the current status, for example why registration failed. StatusMessage types.String `tfsdk:"status_message" tf:"optional"` // Array of tags that are associated with the model version. Tags []ModelVersionTag `tfsdk:"tags" tf:"optional"` // The username of the user that created the object. UserId types.String `tfsdk:"user_id" tf:"optional"` // Version of the model. Version types.String `tfsdk:"version" tf:"optional"` }
type ModelVersionTag ¶
type RegisteredModelAccessControlRequest ¶
type RegisteredModelAccessControlRequest struct { // name of the group GroupName types.String `tfsdk:"group_name" tf:"optional"` // Permission level PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"` // application ID of a service principal ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"` // name of the user UserName types.String `tfsdk:"user_name" tf:"optional"` }
type RegisteredModelAccessControlResponse ¶
type RegisteredModelAccessControlResponse struct { // All permissions. AllPermissions []RegisteredModelPermission `tfsdk:"all_permissions" tf:"optional"` // Display name of the user or service principal. DisplayName types.String `tfsdk:"display_name" tf:"optional"` // name of the group GroupName types.String `tfsdk:"group_name" tf:"optional"` // Name of the service principal. ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"` // name of the user UserName types.String `tfsdk:"user_name" tf:"optional"` }
type RegisteredModelPermissions ¶
type RegisteredModelPermissions struct { AccessControlList []RegisteredModelAccessControlResponse `tfsdk:"access_control_list" tf:"optional"` ObjectId types.String `tfsdk:"object_id" tf:"optional"` ObjectType types.String `tfsdk:"object_type" tf:"optional"` }
type RegisteredModelPermissionsRequest ¶
type RegisteredModelPermissionsRequest struct { AccessControlList []RegisteredModelAccessControlRequest `tfsdk:"access_control_list" tf:"optional"` // The registered model for which to get or manage permissions. RegisteredModelId types.String `tfsdk:"-"` }
type RegistryWebhook ¶
type RegistryWebhook struct { // Creation time of the object, as a Unix timestamp in milliseconds. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // User-specified description for the webhook. Description types.String `tfsdk:"description" tf:"optional"` // 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. Events []types.String `tfsdk:"events" tf:"optional"` HttpUrlSpec *HttpUrlSpecWithoutSecret `tfsdk:"http_url_spec" tf:"optional"` // Webhook ID Id types.String `tfsdk:"id" tf:"optional"` JobSpec *JobSpecWithoutSecret `tfsdk:"job_spec" tf:"optional"` // Time of the object at last update, as a Unix timestamp in milliseconds. LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"` // Name of the model whose events would trigger this webhook. ModelName types.String `tfsdk:"model_name" tf:"optional"` // 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. Status types.String `tfsdk:"status" tf:"optional"` }
type RejectTransitionRequest ¶
type RejectTransitionRequest struct { // User-provided comment on the action. Comment types.String `tfsdk:"comment" tf:"optional"` // Name of the model. Name types.String `tfsdk:"name" tf:""` // 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. Stage types.String `tfsdk:"stage" tf:""` // Version of the model. Version types.String `tfsdk:"version" tf:""` }
type RejectTransitionRequestResponse ¶
type RejectTransitionRequestResponse struct { // Activity recorded for the action. Activity *Activity `tfsdk:"activity" tf:"optional"` }
type RenameModelRequest ¶
type RenameModelResponse ¶
type RenameModelResponse struct {
RegisteredModel *Model `tfsdk:"registered_model" tf:"optional"`
}
type RestoreExperiment ¶
type RestoreExperimentResponse ¶
type RestoreExperimentResponse struct { }
type RestoreRun ¶
type RestoreRunResponse ¶
type RestoreRunResponse struct { }
type RestoreRuns ¶
type RestoreRuns struct { // The ID of the experiment containing the runs to restore. ExperimentId types.String `tfsdk:"experiment_id" tf:""` // An optional positive integer indicating the maximum number of runs to // restore. The maximum allowed value for max_runs is 10000. MaxRuns types.Int64 `tfsdk:"max_runs" tf:"optional"` // The minimum deletion timestamp in milliseconds since the UNIX epoch for // restoring runs. Only runs deleted no earlier than this timestamp are // restored. MinTimestampMillis types.Int64 `tfsdk:"min_timestamp_millis" tf:""` }
type RestoreRunsResponse ¶
type RunInfo ¶
type RunInfo struct { // URI of the directory where artifacts should be uploaded. This can be a // local path (starting with "/"), or a distributed file system (DFS) path, // like `s3://bucket/directory` or `dbfs:/my/directory`. If not set, the // local `./mlruns` directory is chosen. ArtifactUri types.String `tfsdk:"artifact_uri" tf:"optional"` // Unix timestamp of when the run ended in milliseconds. EndTime types.Int64 `tfsdk:"end_time" tf:"optional"` // The experiment ID. ExperimentId types.String `tfsdk:"experiment_id" tf:"optional"` // Current life cycle stage of the experiment : OneOf("active", "deleted") LifecycleStage types.String `tfsdk:"lifecycle_stage" tf:"optional"` // Unique identifier for the run. RunId types.String `tfsdk:"run_id" tf:"optional"` // [Deprecated, use run_id instead] Unique identifier for the run. This // field will be removed in a future MLflow version. RunUuid types.String `tfsdk:"run_uuid" tf:"optional"` // Unix timestamp of when the run started in milliseconds. StartTime types.Int64 `tfsdk:"start_time" tf:"optional"` // Current status of the run. Status types.String `tfsdk:"status" tf:"optional"` // User who initiated 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. UserId types.String `tfsdk:"user_id" tf:"optional"` }
type RunInputs ¶
type RunInputs struct { // Run metrics. DatasetInputs []DatasetInput `tfsdk:"dataset_inputs" tf:"optional"` }
type SearchExperiments ¶
type SearchExperiments struct { // String representing a SQL filter condition (e.g. "name ILIKE // 'my-experiment%'") Filter types.String `tfsdk:"filter" tf:"optional"` // Maximum number of experiments desired. Max threshold is 3000. MaxResults types.Int64 `tfsdk:"max_results" tf:"optional"` // List of columns for ordering search results, which can include experiment // name and last updated timestamp with an optional "DESC" or "ASC" // annotation, where "ASC" is the default. Tiebreaks are done by experiment // id DESC. OrderBy []types.String `tfsdk:"order_by" tf:"optional"` // Token indicating the page of experiments to fetch PageToken types.String `tfsdk:"page_token" tf:"optional"` // Qualifier for type of experiments to be returned. If unspecified, return // only active experiments. ViewType types.String `tfsdk:"view_type" tf:"optional"` }
type SearchExperimentsResponse ¶
type SearchExperimentsResponse struct { // Experiments that match the search criteria Experiments []Experiment `tfsdk:"experiments" tf:"optional"` // Token that can be used to retrieve the next page of experiments. An empty // token means that no more experiments are available for retrieval. NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"` }
type SearchModelVersionsRequest ¶
type SearchModelVersionsRequest struct { // String filter condition, like "name='my-model-name'". Must be a single // boolean condition, with string values wrapped in single quotes. Filter types.String `tfsdk:"-"` // Maximum number of models desired. Max threshold is 10K. MaxResults types.Int64 `tfsdk:"-"` // List of columns to be ordered by including model name, version, stage // with an optional "DESC" or "ASC" annotation, where "ASC" is the default. // Tiebreaks are done by latest stage transition timestamp, followed by name // ASC, followed by version DESC. OrderBy []types.String `tfsdk:"-"` // Pagination token to go to next page based on previous search query. PageToken types.String `tfsdk:"-"` }
Searches model versions
type SearchModelVersionsResponse ¶
type SearchModelVersionsResponse struct { // Models that match the search criteria ModelVersions []ModelVersion `tfsdk:"model_versions" tf:"optional"` // Pagination token to request next page of models for the same search // query. NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"` }
type SearchModelsRequest ¶
type SearchModelsRequest struct { // String filter condition, like "name LIKE 'my-model-name'". Interpreted in // the backend automatically as "name LIKE '%my-model-name%'". Single // boolean condition, with string values wrapped in single quotes. Filter types.String `tfsdk:"-"` // Maximum number of models desired. Default is 100. Max threshold is 1000. MaxResults types.Int64 `tfsdk:"-"` // List of columns for ordering search results, which can include model name // and last updated timestamp with an optional "DESC" or "ASC" annotation, // where "ASC" is the default. Tiebreaks are done by model name ASC. OrderBy []types.String `tfsdk:"-"` // Pagination token to go to the next page based on a previous search query. PageToken types.String `tfsdk:"-"` }
Search models
type SearchModelsResponse ¶
type SearchRuns ¶
type SearchRuns struct { // List of experiment IDs to search over. ExperimentIds []types.String `tfsdk:"experiment_ids" tf:"optional"` // A filter expression over params, metrics, and tags, that allows returning // a subset of runs. The syntax is a subset of SQL that supports ANDing // together binary operations between a param, metric, or tag and a // constant. // // Example: `metrics.rmse < 1 and params.model_class = 'LogisticRegression'` // // You can select columns with special characters (hyphen, space, period, // etc.) by using double quotes: `metrics."model class" = 'LinearRegression' // and tags."user-name" = 'Tomas'` // // Supported operators are `=`, `!=`, `>`, `>=`, `<`, and `<=`. Filter types.String `tfsdk:"filter" tf:"optional"` // Maximum number of runs desired. Max threshold is 50000 MaxResults types.Int64 `tfsdk:"max_results" tf:"optional"` // List of columns to be ordered by, including attributes, params, metrics, // and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the // default. Example: ["params.input DESC", "metrics.alpha ASC", // "metrics.rmse"] Tiebreaks are done by start_time DESC followed by run_id // for runs with the same start time (and this is the default ordering // criterion if order_by is not provided). OrderBy []types.String `tfsdk:"order_by" tf:"optional"` // Token for the current page of runs. PageToken types.String `tfsdk:"page_token" tf:"optional"` // Whether to display only active, only deleted, or all runs. Defaults to // only active runs. RunViewType types.String `tfsdk:"run_view_type" tf:"optional"` }
type SearchRunsResponse ¶
type SetExperimentTag ¶
type SetExperimentTag struct { // ID of the experiment under which to log the tag. Must be provided. ExperimentId types.String `tfsdk:"experiment_id" tf:""` // Name of the tag. Maximum size depends on storage backend. All storage // backends are guaranteed to support key values up to 250 bytes in size. Key types.String `tfsdk:"key" tf:""` // String value of the tag being logged. Maximum size depends on storage // backend. All storage backends are guaranteed to support key values up to // 5000 bytes in size. Value types.String `tfsdk:"value" tf:""` }
type SetExperimentTagResponse ¶
type SetExperimentTagResponse struct { }
type SetModelTagRequest ¶
type SetModelTagRequest struct { // Name of the tag. Maximum size depends on storage backend. If a tag with // this name already exists, its preexisting value will be replaced by the // specified `value`. All storage backends are guaranteed to support key // values up to 250 bytes in size. Key types.String `tfsdk:"key" tf:""` // Unique name of the model. Name types.String `tfsdk:"name" tf:""` // String value of the tag being logged. Maximum size depends on storage // backend. All storage backends are guaranteed to support key values up to // 5000 bytes in size. Value types.String `tfsdk:"value" tf:""` }
type SetModelTagResponse ¶
type SetModelTagResponse struct { }
type SetModelVersionTagRequest ¶
type SetModelVersionTagRequest struct { // Name of the tag. Maximum size depends on storage backend. If a tag with // this name already exists, its preexisting value will be replaced by the // specified `value`. All storage backends are guaranteed to support key // values up to 250 bytes in size. Key types.String `tfsdk:"key" tf:""` // Unique name of the model. Name types.String `tfsdk:"name" tf:""` // String value of the tag being logged. Maximum size depends on storage // backend. All storage backends are guaranteed to support key values up to // 5000 bytes in size. Value types.String `tfsdk:"value" tf:""` // Model version number. Version types.String `tfsdk:"version" tf:""` }
type SetModelVersionTagResponse ¶
type SetModelVersionTagResponse struct { }
type SetTag ¶
type SetTag struct { // Name of the tag. Maximum size depends on storage backend. All storage // backends are guaranteed to support key values up to 250 bytes in size. Key types.String `tfsdk:"key" tf:""` // ID of the run under which to log the tag. Must be provided. RunId types.String `tfsdk:"run_id" tf:"optional"` // [Deprecated, use run_id instead] ID of the run under which to log the // tag. This field will be removed in a future MLflow version. RunUuid types.String `tfsdk:"run_uuid" tf:"optional"` // String value of the tag being logged. Maximum size depends on storage // backend. All storage backends are guaranteed to support key values up to // 5000 bytes in size. Value types.String `tfsdk:"value" tf:""` }
type SetTagResponse ¶
type SetTagResponse struct { }
type TestRegistryWebhook ¶
type TestRegistryWebhook struct { // Body of the response from the webhook URL Body types.String `tfsdk:"body" tf:"optional"` // Status code returned by the webhook URL StatusCode types.Int64 `tfsdk:"status_code" tf:"optional"` }
Test webhook response object.
type TestRegistryWebhookRequest ¶
type TestRegistryWebhookRequest struct { // If `event` is specified, the test trigger uses the specified event. If // `event` is not specified, the test trigger uses a randomly chosen event // associated with the webhook. Event types.String `tfsdk:"event" tf:"optional"` // Webhook ID Id types.String `tfsdk:"id" tf:""` }
type TestRegistryWebhookResponse ¶
type TestRegistryWebhookResponse struct { // Test webhook response object. Webhook *TestRegistryWebhook `tfsdk:"webhook" tf:"optional"` }
type TransitionModelVersionStageDatabricks ¶
type TransitionModelVersionStageDatabricks struct { // Specifies whether to archive all current model versions in the target // stage. ArchiveExistingVersions types.Bool `tfsdk:"archive_existing_versions" tf:""` // User-provided comment on the action. Comment types.String `tfsdk:"comment" tf:"optional"` // Name of the model. Name types.String `tfsdk:"name" tf:""` // 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. Stage types.String `tfsdk:"stage" tf:""` // Version of the model. Version types.String `tfsdk:"version" tf:""` }
type TransitionRequest ¶
type TransitionRequest struct { // Array of actions on the activity allowed for the current viewer. AvailableActions []types.String `tfsdk:"available_actions" tf:"optional"` // User-provided comment associated with the transition request. Comment types.String `tfsdk:"comment" tf:"optional"` // Creation time of the object, as a Unix timestamp in milliseconds. CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"` // 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. ToStage types.String `tfsdk:"to_stage" tf:"optional"` // The username of the user that created the object. UserId types.String `tfsdk:"user_id" tf:"optional"` }
Transition request details.
type TransitionStageResponse ¶
type TransitionStageResponse struct {
ModelVersion *ModelVersionDatabricks `tfsdk:"model_version" tf:"optional"`
}
type UpdateComment ¶
type UpdateCommentResponse ¶
type UpdateCommentResponse struct { // Comment details. Comment *CommentObject `tfsdk:"comment" tf:"optional"` }
type UpdateExperiment ¶
type UpdateExperimentResponse ¶
type UpdateExperimentResponse struct { }
type UpdateModelRequest ¶
type UpdateModelResponse ¶
type UpdateModelResponse struct { }
type UpdateModelVersionRequest ¶
type UpdateModelVersionRequest struct { // If provided, updates the description for this `registered_model`. Description types.String `tfsdk:"description" tf:"optional"` // Name of the registered model Name types.String `tfsdk:"name" tf:""` // Model version number Version types.String `tfsdk:"version" tf:""` }
type UpdateModelVersionResponse ¶
type UpdateModelVersionResponse struct { }
type UpdateRegistryWebhook ¶
type UpdateRegistryWebhook struct { // User-specified description for the webhook. Description types.String `tfsdk:"description" tf:"optional"` // 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. Events []types.String `tfsdk:"events" tf:"optional"` HttpUrlSpec *HttpUrlSpec `tfsdk:"http_url_spec" tf:"optional"` // Webhook ID Id types.String `tfsdk:"id" tf:""` JobSpec *JobSpec `tfsdk:"job_spec" tf:"optional"` // 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. Status types.String `tfsdk:"status" tf:"optional"` }
type UpdateRun ¶
type UpdateRun struct { // Unix timestamp in milliseconds of when the run ended. EndTime types.Int64 `tfsdk:"end_time" tf:"optional"` // ID of the run to update. Must be provided. RunId types.String `tfsdk:"run_id" tf:"optional"` // [Deprecated, use run_id instead] ID of the run to update.. This field // will be removed in a future MLflow version. RunUuid types.String `tfsdk:"run_uuid" tf:"optional"` // Updated status of the run. Status types.String `tfsdk:"status" tf:"optional"` }
type UpdateRunResponse ¶
type UpdateRunResponse struct { // Updated metadata of the run. RunInfo *RunInfo `tfsdk:"run_info" tf:"optional"` }
type UpdateWebhookResponse ¶
type UpdateWebhookResponse struct { }