Azure Assistentes OpenAI chamada de função (clássico)

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

Nota

Links neste artigo podem abrir conteúdo na nova documentação do Microsoft Foundry em vez da documentação da Foundry (clássica) que você está exibindo agora.

Nota

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

A API de Assistentes dá suporte à chamada de função, que permite descrever a estrutura de funções para um Assistente e, em seguida, retornar as funções que precisam ser chamadas junto com seus argumentos.

Suporte à chamada de função

Modelos com suporte

A página de modelos contém as informações mais atualizadas sobre regiões/modelos que oferecem suporte aos Assistentes.

Para usar todos os recursos de chamada de função, incluindo funções paralelas, você precisa usar um modelo que foi lançado após 6 de novembro de 2023.

Versões da API

Versões de API começando com 2024-02-15-preview.

Definição de função de exemplo

Nota

  • Adicionamos 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_interpreterou um function) em uma execução específica.
  • As execuções expiram dez minutos após a criação. Certifique-se de enviar as saídas da ferramenta antes do prazo de expiração.
  • Você também pode executar a chamada 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"]
      }
    }
  }]
)

Lendo as funções

Quando você inicia uma Execução com uma mensagem de usuário que aciona a função, a Execução entrará em um status pendente. Após o processamento, a execução entrará em um estado requires_action que você pode verificar recuperando o Run.

{
  "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\"}"
          }
        },
      ]
    }
  },
...

Enviar saídas de função

Em seguida, você pode concluir a Execução submetendo a saída da ferramenta gerada pelas funções que você chamou. Passe o tool_call_id referenciado no required_action objeto para 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 enviar os resultados da ferramenta, o Run entrará no estado queued antes de continuar a execução.

Consulte também

  • Last updated on