Chamada de funções do Azure OpenAI Assistants (clássico)

Aplica-se apenas a:Portal Foundry (clássico). Este artigo não está disponível para o novo portal da Foundry. Saiba mais sobre o novo portal.

Nota

Os links neste artigo podem abrir conteúdo na nova documentação do Microsoft Foundry em vez da documentação do Foundry (clássico) que está a ver agora.

Nota

A API dos Assistentes está obsoleta e será retirada a 26 de agosto de 2026. Use o serviço geralmente disponível Microsoft Foundry Agents. Siga o guia de migração para atualizar as suas cargas de trabalho. Saiba mais.

A API dos Assistentes suporta chamada de funções, o que permite descrever a estrutura das funções a um Assistente e depois devolver as funções que precisam de ser chamadas juntamente com os seus argumentos.

Suporte para chamadas de função

Modelos suportados

A página de modelos contém a informação mais atualizada sobre as regiões/modelos onde os Assistentes são suportados.

Para usar todas as funcionalidades da chamada de funções, incluindo funções paralelas, é necessário usar um modelo lançado após 6 de novembro de 2023.

Versões API

Versões da API que começam por 2024-02-15-preview.

Exemplo de definição de função

Nota

  • Adicionámos suporte para o tool_choice parâmetro que pode ser usado para forçar o uso de uma ferramenta específica (como file_search, code_interpreter, ou um function) numa determinada execução.
  • As sessões expiram dez minutos após a criação. Certifique-se de submeter os resultados da sua ferramenta antes desta expiração.
  • Também pode realizar chamadas de função com Azure Logic Apps
from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-07-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

assistant = client.beta.assistants.create(
  name="Weather Bot",
  instructions="You are a weather bot. Use the provided functions to answer questions.",
  model="gpt-4", #Replace with model deployment name
  tools=[{
      "type": "function",
    "function": {
      "name": "get_weather",
      "description": "Get the weather in location",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {"type": "string", "description": "The city name, for example San Francisco"}
        },
        "required": ["location"]
      }
    }
  }]
)

Leitura das funções

Quando inicias uma Execução com uma Mensagem de utilizador que desencadeia a função, a Execução entra num estado pendente. Depois de processada, a execução entra num estado denominado requires_action que pode verificar recuperando a Execução.

{
  "id": "run_abc123",
  "object": "thread.run",
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "status": "requires_action",
  "required_action": {
    "type": "submit_tool_outputs",
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "id": "call_abc123",
          "type": "function",
          "function": {
            "name": "get_weather",
            "arguments": "{\"location\":\"Seattle\"}"
          }
        },
      ]
    }
  },
...

Submissão de resultados de funções

Pode então completar a Execução submetendo a saída da(s) função(ões) invocada(s) pela ferramenta. Passe o tool_call_id no objeto required_action referenciado para fazer corresponder a saída a cada chamada de função.


# Example function
def get_weather():
    return "It's 80 degrees F and slightly cloudy."

# Define the list to store tool outputs
tool_outputs = []
 
# Loop through each tool in the required action section
for tool in run.required_action.submit_tool_outputs.tool_calls:
  # get data from the weather function
  if tool.function.name == "get_weather":
    weather = get_weather()
    tool_outputs.append({
      "tool_call_id": tool.id,
      "output": weather
    })
 
# Submit all tool outputs at once after collecting them in a list
if tool_outputs:
  try:
    run = client.beta.threads.runs.submit_tool_outputs_and_poll(
      thread_id=thread.id,
      run_id=run.id,
      tool_outputs=tool_outputs
    )
    print("Tool outputs submitted successfully.")
  except Exception as e:
    print("Failed to submit tool outputs:", e)
else:
  print("No tool outputs to submit.")
 
if run.status == 'completed':
  print("run status: ", run.status)
  messages = client.beta.threads.messages.list(thread_id=thread.id)
  print(messages.to_json(indent=2))

else:
  print("run status: ", run.status)
  print (run.last_error.message)

Depois de submeteres os resultados da ferramenta, a Run entrará no estado queued antes de continuar a execução.

Ver também

  • Last updated on