from mlteam_utils import print_object

# In this example, we're creating an Assistant that is a personal math tutor, with the Code Interpreter tool enabled.
from openai import OpenAI
client = OpenAI()

assistant = client.beta.assistants.create(
    name="Math Tutor",
    instructions="You are a personal math tutor. Write and run code to answer math questions.",
    tools=[{"type": "code_interpreter"}],
    model="gpt-4o-mini"
)

thread = client.beta.threads.create()

message = client.beta.threads.messages.create(
    thread_id=thread.id,
    role="user",
    content="I need to solve the equation `3x + 11 = 14`. Can you help me?"
)

# Now if you list the Messages in a Thread, you will see that this message has been appended.
thread_messages = client.beta.threads.messages.list(thread.id)
print_object(thread_messages.data)

[
    {
        "id": "msg_J1xnOOQhiTWsgB8dzmA59iOW",
        "assistant_id": null,
        "attachments": [],
        "completed_at": null,
        "content": [
            {
                "text": {
                    "annotations": [],
                    "value": "I need to solve the equation `3x + 11 = 14`. Can you help me?"
                },
                "type": "text"
            }
        ],
        "created_at": 1714312439,
        "incomplete_at": null,
        "incomplete_details": null,
        "metadata": {},
        "object": "thread.message",
        "role": "user",
        "run_id": null,
        "status": null,
        "thread_id": "thread_NwIIUxyNx3h6m3JejynlCDtD"
    }
]

# Trigger the run
run = client.beta.threads.runs.create(
  thread_id=thread.id,
  assistant_id=assistant.id,
  instructions="Please address the user as Jane Doe. The user has a premium account."
)

# By default, the run goes into the queued state. You can periodically retrieve the Run to check on its status to see if it has moved to completed.
import time

while True:
    time.sleep(5)
    run = client.beta.threads.runs.retrieve(
      thread_id=thread.id,
      run_id=run.id
    )
    if run.status in ['queued', 'in_progress', 'requires_action', 'cancelling']:
        continue
    if run.status in ["completed", "expired", "failed", "cancelled"]:
        print(f"Run is {run.status}")
        break
    break
print_object(run)

Run is completed
{
    "id": "run_2Esq6yOwnUR5eAZiudJwHAVB",
    "assistant_id": "asst_5omknA43lpIUtS5ACC1ODpJI",
    "cancelled_at": null,
    "completed_at": 1714312456,
    "created_at": 1714312446,
    "expires_at": null,
    "failed_at": null,
    "incomplete_details": null,
    "instructions": "Please address the user as Jane Doe. The user has a premium account.",
    "last_error": null,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "metadata": {},
    "model": "gpt-4-turbo",
    "object": "thread.run",
    "required_action": null,
    "response_format": "auto",
    "started_at": 1714312446,
    "status": "completed",
    "thread_id": "thread_NwIIUxyNx3h6m3JejynlCDtD",
    "tool_choice": "auto",
    "tools": [
        {
            "type": "code_interpreter"
        }
    ],
    "truncation_strategy": {
        "type": "auto",
        "last_messages": null
    },
    "usage": {
        "completion_tokens": 155,
        "prompt_tokens": 656,
        "total_tokens": 811
    },
    "temperature": 1.0,
    "top_p": 1.0
}

messages = client.beta.threads.messages.list(
  thread_id=thread.id
)

#For you to better understand the data structure of the messages
print_object(messages.data)

[
    {
        "id": "msg_2TlOXBihTPslVWb9hHk3Hm9m",
        "assistant_id": "asst_5omknA43lpIUtS5ACC1ODpJI",
        "attachments": [],
        "completed_at": null,
        "content": [
            {
                "text": {
                    "annotations": [],
                    "value": "The solution to the equation \\(3x + 11 = 14\\) is \\(x = 1.0\\)."
                },
                "type": "text"
            }
        ],
        "created_at": 1714312455,
        "incomplete_at": null,
        "incomplete_details": null,
        "metadata": {},
        "object": "thread.message",
        "role": "assistant",
        "run_id": "run_2Esq6yOwnUR5eAZiudJwHAVB",
        "status": null,
        "thread_id": "thread_NwIIUxyNx3h6m3JejynlCDtD"
    },
    {
        "id": "msg_e8wmwcwwsaZW5hZdtooCLMj3",
        "assistant_id": "asst_5omknA43lpIUtS5ACC1ODpJI",
        "attachments": [],
        "completed_at": null,
        "content": [
            {
                "text": {
                    "annotations": [],
                    "value": "Sure, Jane Doe! Let's solve the equation \\(3x + 11 = 14\\).\n\nFirst, we'll isolate the \\(x\\) term by subtracting 11 from both sides of the equation:\n\\[3x + 11 - 11 = 14 - 11\\]\n\nThis simplifies to:\n\\[3x = 3\\]\n\nNow, divide both sides by 3 to find \\(x\\):\n\\[x = \\frac{3}{3}\\]\n\nLet's calculate that."
                },
                "type": "text"
            }
        ],
        "created_at": 1714312447,
        "incomplete_at": null,
        "incomplete_details": null,
        "metadata": {},
        "object": "thread.message",
        "role": "assistant",
        "run_id": "run_2Esq6yOwnUR5eAZiudJwHAVB",
        "status": null,
        "thread_id": "thread_NwIIUxyNx3h6m3JejynlCDtD"
    },
    {
        "id": "msg_J1xnOOQhiTWsgB8dzmA59iOW",
        "assistant_id": null,
        "attachments": [],
        "completed_at": null,
        "content": [
            {
                "text": {
                    "annotations": [],
                    "value": "I need to solve the equation `3x + 11 = 14`. Can you help me?"
                },
                "type": "text"
            }
        ],
        "created_at": 1714312439,
        "incomplete_at": null,
        "incomplete_details": null,
        "metadata": {},
        "object": "thread.message",
        "role": "user",
        "run_id": null,
        "status": null,
        "thread_id": "thread_NwIIUxyNx3h6m3JejynlCDtD"
    }
]

# Finally display the messages to the user

# messages.data list holds the last message at the index 0, so we reverse the list to see in chronological order.
for message in reversed(messages.data):
  print(f"_______Role: {message['role']}_______\n")
  # message.content is a list, but I only see 1 item in the list, anyhow used a loop.
  for i, content in enumerate(message['content']):
    print(f"{content['text']['value']}\n")

_______Role: user_______

I need to solve the equation `3x + 11 = 14`. Can you help me?

_______Role: assistant_______

Sure, Jane Doe! Let's solve the equation \(3x + 11 = 14\).

First, we'll isolate the \(x\) term by subtracting 11 from both sides of the equation:
\[3x + 11 - 11 = 14 - 11\]

This simplifies to:
\[3x = 3\]

Now, divide both sides by 3 to find \(x\):
\[x = \frac{3}{3}\]

Let's calculate that.

_______Role: assistant_______

The solution to the equation \(3x + 11 = 14\) is \(x = 1.0\).

run_steps = client.beta.threads.runs.steps.list(
    thread_id=thread.id,
    run_id=run.id
)

for step in run_steps:
    print(f"{step.step_details.type}: {getattr(step.step_details, step.step_details.type)}")

message_creation: MessageCreation(message_id='msg_2TlOXBihTPslVWb9hHk3Hm9m')
tool_calls: [CodeInterpreterToolCall(id='call_e7FhPzw7N6VlGSDXKNebTcAv', code_interpreter=CodeInterpreter(input='# Calculating the value of x\r\nx = 3 / 3\r\nx', outputs=[CodeInterpreterOutputLogs(logs='1.0', type='logs')]), type='code_interpreter')]
message_creation: MessageCreation(message_id='msg_e8wmwcwwsaZW5hZdtooCLMj3')

try:
    # Delete the assistant
    client.beta.assistants.delete(assistant_id=assistant.id)

    # Delete the thread
    client.beta.threads.delete(thread_id=thread.id)
except Exception as e:
  print(e)

OBJECT	WHAT IT REPRESENTS
Assistant	Purpose-built AI that uses OpenAI’s models and calls tools
Thread	A conversation session between an Assistant and a user. Threads store Messages and automatically handle truncation to fit content into a model’s context.
Message	A message created by an Assistant or a user. Messages can include text, images, and other files. Messages stored as a list on the Thread.
Run	An invocation of an Assistant on a Thread. The Assistant uses its configuration and the Thread’s Messages to perform tasks by calling models and tools. As part of a Run, the Assistant appends Messages to the Thread.
Run Step	A detailed list of steps the Assistant took as part of a Run. An Assistant can call tools or create Messages during its run. Examining Run Steps allows you to introspect how the Assistant is getting to its final results.

STATUS	DEFINITION
queued	When Runs are first created or when you complete the required_action, they are moved to a queued status. They should almost immediately move to in_progress.
in_progress	While in_progress, the Assistant uses the model and tools to perform steps. You can view progress being made by the Run by examining the Run Steps.
completed	The Run successfully completed! You can now view all Messages the Assistant added to the Thread, and all the steps the Run took. You can also continue the conversation by adding more user Messages to the Thread and creating another Run.
requires_action	When using the Function calling tool, the Run will move to a required_action state once the model determines the names and arguments of the functions to be called. You must then run those functions and submit the outputs before the run proceeds. If the outputs are not provided before the expires_at timestamp passes (roughly 10 mins past creation), the run will move to an expired status.
expired	This happens when the function calling outputs were not submitted before expires_at and the run expires. Additionally, if the runs take too long to execute and go beyond the time stated in expires_at, OpenAI systems will expire the run.
cancelling	You can attempt to cancel an in_progress run using the Cancel Run endpoint. Once the attempt to cancel succeeds, status of the Run moves to cancelled. Cancellation is attempted but not guaranteed.
cancelled	Run was successfully cancelled.
failed	You can view the reason for the failure by looking at the last_error object in the Run. The timestamp for the failure will be recorded under failed_at.

Assistants¶

Introduction¶

How Assistants Work¶

Objects¶

Step 1: Create an Assistant¶

Step 2: Create a Thread¶

Step 3: Add a Message to a Thread¶

Step 4: Run the Assistant¶

Step5: Check the Run Status¶

Step 6: Display the Assistant's Response¶

Run Steps¶

Cleanup¶