Crie e edite solicitações

info

Beta

Esse recurso está na versão beta.

Esta página mostra como criar novos prompts e gerenciar suas versões no MLflow Prompt Registry usando o MLflow Python SDK. Ele inclui instruções para usar o MLflow Python SDK e a interface de usuário do MLflow da Databricks. Todo o código desta página está incluído no Notebook de exemplo.

Pré-requisitos

1. Instale o site MLflow e o pacote necessário

   Bash

   pip install --upgrade "mlflow[databricks]>=3.1.0" openai

2. Crie um experimento do MLflow seguindo o início rápido da configuração do ambiente.

3. Crie ou identifique um esquema do Unity Catalog para armazenar prompts. O senhor deve ter os privilégios CREATE FUNCTION, EXECUTE e MANAGE no esquema do Unity Catalog.

Etapa 1. Crie um novo prompt

O senhor pode criar prompts na UI do Databricks MLflow ou programaticamente usando o Python SDK.

Usar a interface de usuário do Databricks MLflow

Para criar um prompt na interface do usuário:

1. Navegue até seu experimento MLflow.

2. Clique em Prompts tab.

   

3. Clique em Selecionar um esquema e clique no catálogo e no esquema em que você deseja armazenar a solicitação.

4. Clique em Confirmar .

5. Clique .

6. Insira um nome para o prompt e clique em Criar .

7. Clique em Criar nova versão .

8. Digite sua solicitação e clique em Salvar . Você pode usar variáveis no texto do prompt usando a sintaxe {{variable_name}}.

O prompt aparece na interface do usuário:

Use o Python SDK

1. Vincule seu experimento MLflow a um local do Prompt Registry default definindo um experimento tag usando mlflow.set_experiment_tags. Isso permite que os SDKs e as ferramentas deduzam automaticamente o esquema de prompt do Unity Catalog.

   Use a tag mlflow.promptRegistryLocation com o valor catalog.schema:

   Python

   import mlflow
   
   # Link the current MLflow experiment to a UC schema for prompts
   mlflow.set_experiment_tags({
       "mlflow.promptRegistryLocation": "main.default"
   })

2. Crie prompts usando mlflow.genai.register_prompt(). Os prompts usam a sintaxe de dupla trava ({{variable}}) para variáveis padrão.

Python

# Replace with a Unity Catalog schema where you have CREATE FUNCTION, EXECUTE, and MANAGE privileges
uc_schema = "main.default"
# This table is created in the UC schema specified in the previous line
prompt_name = "summarization_prompt"

# Define the prompt template with variables
initial_template = """\
Summarize content you are provided with in {{num_sentences}} sentences.

Content: {{content}}
"""

# Register a new prompt
prompt = mlflow.genai.register_prompt(
    name=f"{uc_schema}.{prompt_name}",
    template=initial_template,
    # all following parameters are optional
    commit_message="Initial version of summarization prompt",
    tags={
        "author": "data-science-team@company.com",
        "use_case": "document_summarization",
        "task": "summarization",
        "language": "en",
        "model_compatibility": "gpt-4"
    }
)

print(f"Created prompt '{prompt.name}' (version {prompt.version})")

Etapa 2: use o prompt em seu aplicativo

As etapas a seguir criam um aplicativo simples que usa o prompt padrão.

Carregue o prompt do registro

Python

# Load a specific version using URI syntax
prompt = mlflow.genai.load_prompt(name_or_uri=f"prompts:/{uc_schema}.{prompt_name}/1")

# Alternative syntax without URI
prompt = mlflow.genai.load_prompt(name_or_uri=f"{uc_schema}.{prompt_name}", version="1")

Use o prompt em seu aplicativo

1. Inicialize um cliente OpenAI para se conectar a LLMs hospedados pela Databricks ou LLMs hospedados pela OpenAI.

Databricks-hosted LLMs

Use o MLflow para obter um cliente OpenAI que se conecta aos LLMs hospedados pela Databricks. Selecione um modelo dentre os modelos de base disponíveis.

Python

import mlflow
from databricks.sdk import WorkspaceClient

# Enable MLflow's autologging to instrument your application with Tracing
mlflow.openai.autolog()

# Set up MLflow tracking to Databricks
mlflow.set_tracking_uri("databricks")
mlflow.set_experiment("/Shared/docs-demo")

# Create an OpenAI client that is connected to Databricks-hosted LLMs
w = WorkspaceClient()
client = w.serving_endpoints.get_open_ai_client()

# Select an LLM
model_name = "databricks-claude-sonnet-4"

OpenAI-hosted LLMs

Use o SDK nativo do OpenAI para se conectar a modelos hospedados pelo OpenAI. Selecione um modelo dentre os modelos OpenAI disponíveis.

Python

import mlflow
import os
import openai

# Ensure your OPENAI_API_KEY is set in your environment
# os.environ["OPENAI_API_KEY"] = "<YOUR_API_KEY>" # Uncomment and set if not globally configured

# Enable auto-tracing for OpenAI
mlflow.openai.autolog()

# Set up MLflow tracking to Databricks
mlflow.set_tracking_uri("databricks")
mlflow.set_experiment("/Shared/docs-demo")

# Create an OpenAI client connected to OpenAI SDKs
client = openai.OpenAI()

# Select an LLM
model_name = "gpt-4o-mini"

2. Defina seu aplicativo:

   Python

   # Use the trace decorator to capture the application's entry point
   @mlflow.trace
   def my_app(content: str, num_sentences: int):
       # Format with variables
       formatted_prompt = prompt.format(
           content=content,
           num_sentences=num_sentences
       )
   
       response = client.chat.completions.create(
           model=model_name,  # This example uses a Databricks hosted LLM. You can replace this with any AI Gateway or Model Serving endpoint, or with a valid OpenAI model like gpt-4o.
           messages=[
               {
                   "role": "system",
                   "content": "You are a helpful assistant.",
               },
               {
                   "role": "user",
                   "content": formatted_prompt,
               },
           ],
       )
       return response.choices[0].message.content
   
   result = my_app(content="This guide shows you how to integrate prompts from the MLflow Prompt Registry into your GenAI applications. You'll learn to load prompts, format them with dynamic data, and ensure complete lineage by linking prompt versions to your MLflow Models.", num_sentences=1)
   print(result)

Etapa 3. Edite o prompt

As versões de prompt são imutáveis após sua criação. Para editar um prompt, você deve criar uma nova versão. Esse controle de versão semelhante ao Gitmantém o histórico completo e permite reversões.

Usar a interface de usuário do Databricks MLflow

Para criar uma nova versão:

1. Navegue até o prompt que você deseja editar.

2. Clique em Criar nova versão .

3. Digite sua solicitação e clique em Salvar . A nova versão do prompt aparece na interface do usuário.

   Para comparar as versões do prompt, clique em Comparar no canto superior esquerdo e selecione as versões a serem comparadas.

Use o Python SDK

Crie uma nova versão chamando mlflow.genai.register_prompt() com um nome de prompt existente:

Python

import mlflow

# Define the improved template
new_template = """\
You are an expert summarizer. Condense the following content into exactly {{ num_sentences }} clear and informative sentences that capture the key points.

Content: {{content}}

Your summary should:
- Contain exactly {{num_sentences}} sentences
- Include only the most important information
- Be written in a neutral, objective tone
- Maintain the same level of formality as the original text
"""

# Register a new version
updated_prompt = mlflow.genai.register_prompt(
    name=f"{uc_schema}.{prompt_name}",
    template=new_template,
    commit_message="Added detailed instructions for better output quality",
    tags={
        "author": "data-science-team@company.com",
        "improvement": "Added specific guidelines for summary quality"
    }
)

print(f"Created version {updated_prompt.version} of '{updated_prompt.name}'")

Etapa 4. Use o novo prompt

O código a seguir mostra como usar o prompt.

Python

# Load a specific version using URI syntax
prompt = mlflow.genai.load_prompt(name_or_uri=f"prompts:/{uc_schema}.{prompt_name}/2")

# Or load from specific version
prompt = mlflow.genai.load_prompt(name_or_uri=f"{uc_schema}.{prompt_name}", version="2")

Etapa 5. Solicitações de pesquisa e descoberta

Para encontrar prompts em seu esquema do Unity Catalog:

Python

# REQUIRED format for Unity Catalog - specify catalog and schema
results = mlflow.genai.search_prompts("catalog = 'main' AND schema = 'default'")

# Using variables for your schema
catalog_name = uc_schema.split('.')[0]  # 'main'
schema_name = uc_schema.split('.')[1]   # 'default'
results = mlflow.genai.search_prompts(f"catalog = '{catalog_name}' AND schema = '{schema_name}'")

# Limit results
results = mlflow.genai.search_prompts(
    filter_string=f"catalog = '{catalog_name}' AND schema = '{schema_name}'",
    max_results=50
)

Exemplo de notebook

Criar e editar prompts exemplo Notebook

Open notebook in new tab

Próximas etapas

• Avalie as versões do prompt - Compare as diferentes versões do prompt para identificar o melhor desempenho.
• Acompanhe as solicitações com as versões do aplicativo - Vincule as versões das solicitações às versões do seu aplicativo.
• Use prompts em aplicativos implantados - prompts implantados para produção com aliases.