mlflow.webhooks

MLflow webhooks module.

This module provides webhook functionality for MLflow model registry and prompt registry events.

class mlflow.webhooks.ModelVersionAliasCreatedPayload[source]

Bases: TypedDict

Payload sent when an alias is created for a model version.

Example payload:

{
    "name": "example_model",
    "alias": "example_alias",
    "version": "1",
}

alias: str: The alias being created.

classmethod example() → mlflow.webhooks.types.ModelVersionAliasCreatedPayload[source]

name: str: The name of the registered model.

version: str: The version of the model the alias is being assigned to.

class mlflow.webhooks.ModelVersionAliasDeletedPayload[source]

Bases: TypedDict

Payload sent when an alias is deleted from a model version.

Example payload:

{
    "name": "example_model",
    "alias": "example_alias",
}

alias: str: The alias being deleted.

classmethod example() → mlflow.webhooks.types.ModelVersionAliasDeletedPayload[source]

name: str: The name of the registered model.

class mlflow.webhooks.ModelVersionCreatedPayload[source]

Bases: TypedDict

Payload sent when a new model version is created.

Example payload:

{
    "name": "example_model",
    "version": "1",
    "source": "models:/123",
    "run_id": "abcd1234abcd5678",
    "tags": {"example_key": "example_value"},
    "description": "An example model version",
}

description: str | None: Description of the model version.

classmethod example() → mlflow.webhooks.types.ModelVersionCreatedPayload[source]

name: str: The name of the registered model.

run_id: str | None: The run ID associated with the model version, if applicable.

source: str: The source URI of the model version.

tags: dict[str, str]: Tags associated with the model version.

version: str: The version of the model.

class mlflow.webhooks.ModelVersionTagDeletedPayload[source]

Bases: TypedDict

Payload sent when a tag is deleted from a model version.

Example payload:

{
    "name": "example_model",
    "version": "1",
    "key": "example_key",
}

classmethod example() → mlflow.webhooks.types.ModelVersionTagDeletedPayload[source]

key: str: The tag key being deleted.

name: str: The name of the registered model.

version: str: The version of the model.

class mlflow.webhooks.ModelVersionTagSetPayload[source]

Bases: TypedDict

Payload sent when a tag is set on a model version.

Example payload:

{
    "name": "example_model",
    "version": "1",
    "key": "example_key",
    "value": "example_value",
}

classmethod example() → mlflow.webhooks.types.ModelVersionTagSetPayload[source]

key: str: The tag key being set.

name: str: The name of the registered model.

value: str: The tag value being set.

version: str: The version of the model.

class mlflow.webhooks.PromptAliasCreatedPayload[source]

Bases: TypedDict

Payload sent when an alias is created for a prompt version.

Example payload:

{
    "name": "example_prompt",
    "alias": "example_alias",
    "version": "1",
}

alias: str: The alias being created.

classmethod example() → mlflow.webhooks.types.PromptAliasCreatedPayload[source]

name: str: The name of the prompt.

version: str: The version of the prompt the alias is being assigned to.

class mlflow.webhooks.PromptAliasDeletedPayload[source]

Bases: TypedDict

Payload sent when an alias is deleted from a prompt.

Example payload:

{
    "name": "example_prompt",
    "alias": "example_alias",
}

alias: str: The alias being deleted.

classmethod example() → mlflow.webhooks.types.PromptAliasDeletedPayload[source]

name: str: The name of the prompt.

class mlflow.webhooks.PromptCreatedPayload[source]

Bases: TypedDict

Payload sent when a new prompt is created.

Example payload:

{
    "name": "example_prompt",
    "tags": {"example_key": "example_value"},
    "description": "An example prompt",
}

description: str | None: Description of the prompt.

classmethod example() → mlflow.webhooks.types.PromptCreatedPayload[source]

name: str: The name of the prompt.

tags: dict[str, str]: Tags associated with the prompt.

class mlflow.webhooks.PromptTagDeletedPayload[source]

Bases: TypedDict

Payload sent when a tag is deleted from a prompt.

Example payload:

{
    "name": "example_prompt",
    "key": "example_key",
}

classmethod example() → mlflow.webhooks.types.PromptTagDeletedPayload[source]

key: str: The tag key being deleted.

name: str: The name of the prompt.

class mlflow.webhooks.PromptTagSetPayload[source]

Bases: TypedDict

Payload sent when a tag is set on a prompt.

Example payload:

{
    "name": "example_prompt",
    "key": "example_key",
    "value": "example_value",
}

classmethod example() → mlflow.webhooks.types.PromptTagSetPayload[source]

key: str: The tag key being set.

name: str: The name of the prompt.

value: str: The tag value being set.

class mlflow.webhooks.PromptVersionCreatedPayload[source]

Bases: TypedDict

Payload sent when a new prompt version is created.

Example payload:

{
    "name": "example_prompt",
    "version": "1",
    "template": "Hello {{name}}!",
    "tags": {"example_key": "example_value"},
    "description": "An example prompt version",
}

description: str | None: Description of the prompt version.

classmethod example() → mlflow.webhooks.types.PromptVersionCreatedPayload[source]

name: str: The name of the prompt.

tags: dict[str, str]: Tags associated with the prompt version.

template: str: The template content of the prompt version.

version: str: The version of the prompt.

class mlflow.webhooks.PromptVersionTagDeletedPayload[source]

Bases: TypedDict

Payload sent when a tag is deleted from a prompt version.

Example payload:

{
    "name": "example_prompt",
    "version": "1",
    "key": "example_key",
}

classmethod example() → mlflow.webhooks.types.PromptVersionTagDeletedPayload[source]

key: str: The tag key being deleted.

name: str: The name of the prompt.

version: str: The version of the prompt.

class mlflow.webhooks.PromptVersionTagSetPayload[source]

Bases: TypedDict

Payload sent when a tag is set on a prompt version.

Example payload:

{
    "name": "example_prompt",
    "version": "1",
    "key": "example_key",
    "value": "example_value",
}

classmethod example() → mlflow.webhooks.types.PromptVersionTagSetPayload[source]

key: str: The tag key being set.

name: str: The name of the prompt.

value: str: The tag value being set.

version: str: The version of the prompt.

class mlflow.webhooks.RegisteredModelCreatedPayload[source]

Bases: TypedDict

Payload sent when a new registered model is created.

Example payload:

{
    "name": "example_model",
    "tags": {"example_key": "example_value"},
    "description": "An example registered model",
}

description: str | None: Description of the registered model.

classmethod example() → mlflow.webhooks.types.RegisteredModelCreatedPayload[source]

name: str: The name of the registered model.

tags: dict[str, str]: Tags associated with the registered model.