Ferramenta Python

A ferramenta Python permite-lhe criar excertos de código personalizados como nós executáveis autónomos em fluxo de prompts. Pode facilmente criar ferramentas em Python, editar código e verificar resultados.

Entradas

Types

Os parâmetros com a Connection anotação de tipo são tratados como entradas de ligação, o que significa:

• A extensão de fluxo de prompts mostra um seletor para escolher a ligação.
• Durante a execução, o fluxo de prompts tenta encontrar a ligação com o mesmo nome a partir do valor do parâmetro passado.

Saídas

As saídas são o valor de retorno da função da ferramenta Python.

Escreve com a ferramenta Python

Use as seguintes orientações ao escrever com a ferramenta Python.

Guidelines

• O código da ferramenta Python deve consistir em código Python completo, incluindo quaisquer importações necessárias de módulos.

• Python código da ferramenta deve conter uma função decorada com @tool (função da ferramenta), que serve como ponto de entrada para a execução. Aplique o @tool decorador apenas uma vez no pedaço.

  O exemplo seguinte define a ferramenta Python my_python_tool, que é decorada com @tool.

• Python parâmetros da função ferramenta devem ser atribuídos na secção Inputs.

  O exemplo seguinte define a entrada message e atribui-lhe world.

• Uma função de ferramenta Python deve ter um valor de retorno.

  A amostra seguinte devolve uma cadeia concatenada.

Código

O excerto seguinte mostra a estrutura básica de uma função de ferramenta. O fluxo de prompts lê a função e extrai entradas dos parâmetros da função e das anotações de tipos.

from promptflow import tool
from promptflow.connections import CustomConnection

# The inputs section will change based on the arguments of the tool function, after you save the code
# Adding type to arguments and return value will help the system show the types properly
# Please update the function name/signature per need
@tool
def my_python_tool(message: str, my_conn: CustomConnection) -> str:
    my_conn_dict = dict(my_conn)
    # Do some function call with my_conn_dict...
    return 'hello ' + message

Entradas

O fluxo de prompts tenta encontrar a ligação nomeada my_conn durante a execução.

Saídas

"hello world"

Chame um modelo de raciocínio a partir da ferramenta Python

Se precisares de chamar modelos de raciocínio que o nó LLM não suporta, podes usar a ferramenta Python para chamar os modelos diretamente. O exemplo seguinte mostra como chamar um modelo de raciocínio a partir da ferramenta Python.

from promptflow import tool
from promptflow.connections import AzureOpenAIConnection
from openai import AzureOpenAI
 
@tool
def my_python_tool(
    OpenAIConnection: AzureOpenAIConnection,
    scope_reply: str
):
    model_name = "o3-mini"
    deployment = "o3-mini"
    print(OpenAIConnection['api_base'])
    endpoint = OpenAIConnection['api_base'] #"https://<your endpoint>.openai.azure.com/"
    model_name = "o3-mini" #your model name
    deployment = "o3-mini" #your deployment name
 
    subscription_key = OpenAIConnection['api_key']
    api_version = "2024-12-01-preview" #Supply an API version that supports reasoning models.
 
    client = AzureOpenAI(
        api_version=api_version,
        azure_endpoint=endpoint,
        api_key=subscription_key,
    )
 
    response = client.chat.completions.create(
        messages=[
            {
                "role": "system",
                "content": "You are a helpful assistant.",
            },
            {
                "role": "user",
                "content": "I am going to Paris, what should I see?",
            }
        ],
        max_completion_tokens=100000,
        model=deployment
    )
    return response.choices[0].message.content

Ligação personalizada na ferramenta Python

Se estás a desenvolver uma ferramenta Python que exige chamar serviços externos com autenticação, usa a ligação personalizada em fluxo de prompts. Podes usá-lo para armazenar a chave de acesso de forma segura e depois recuperá-la no teu código Python.

Criar uma ligação personalizada

Crie uma ligação personalizada que armazene todas as chaves de API do seu grande modelo de linguagem ou outras credenciais necessárias.

1. Vai ao fluxo de prompts no teu espaço de trabalho e depois seleciona o separador Conexões .

2. Selecione Criar>Personalizado.

   

3. No painel direito, podes definir o nome da tua ligação. Pode adicionar múltiplos pares chave-valor para armazenar as suas credenciais e chaves selecionando Adicionar pares chave-valor.

   

Usa uma ligação personalizada em Python

Para usar uma ligação personalizada no seu código Python:

1. Na secção de código do seu nó Python, importe a biblioteca de ligação personalizada from promptflow.connections import CustomConnection. Defina um parâmetro de entrada do tipo CustomConnection na função ferramenta.

   

2. Analisa a entrada na secção de entrada e depois seleciona a tua ligação personalizada de alvo no menu suspenso Valor .

   

Por exemplo:

from promptflow import tool
from promptflow.connections import CustomConnection

@tool
def my_python_tool(message: str, myconn: CustomConnection) -> str:
    # Get authentication key-values from the custom connection
    connection_key1_value = myconn.key1
    connection_key2_value = myconn.key2