MessageOperations list method doesn't respect limit parameter

[furoTmark]

• Package Name: azure.ai.projects.aio
• Package Version: 1.0.0
• Operating System: Linux
• Python Version: 3.12.0

Describe the bug
When calling agents_client.messages.list(thread_id=thread_id, limit=limit), the limit parameter is not taken into consideration. I can set any value; it returns all the conversations (I haven't tried it with one that is over 100 messages).

To Reproduce
Steps to reproduce the behavior:

1. Set limit to 10
2. call agents_client.messages.list(thread_id=thread_id, limit=limit) with valid thread_id
3. receive back messages
4. Check the number of messages

Expected behavior
The returned number of messages should be limited to the set value

Additional context
It should work as described in the docs -> https://learn.microsoft.com/en-us/python/api/azure-ai-agents/azure.ai.agents.operations.messagesoperations?view=azure-python-preview#azure-ai-agents-operations-messagesoperations-list

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @dargilco @glharper @howieleung @jhakulin @nick863 @trangevi.

[howieleung]

@furoTmark Thanks for reaching out.
limit doesn't mean it is going to retrieve x number of message at a time by REST api call. With that said, in the following code,

    messages = agents_client.messages.list(thread_id=thread.id, limit=3, order=ListSortOrder.ASCENDING)
    for msg in messages:
   .   ...

The rest api isn't retrieving messages at the moment you call the list function. But when you run the for loop, the iteration triggers the REST api call with limit = 3 to retrieve that number of messages and after processing that number of messages in the for loop, it will then trigger another REST api call with limit = 3 until all messages are processed.

If you are interested in x number of record only, you probably should break in the for loop by counting.

If you are interesting to check the REST api calling, set environment variable ENABLE_AZURE_AI_PROJECTS_CONSOLE_LOGGING=True.

[nick863]

The limit is marking the number of message on the page. Please consider the example:

messages = agents_client.messages.list(thread_id=thread_id, limit=3)
for i, page in enumerate(messages.by_page()):
      print(f"Items on page {i}")
      for message in page:
          print(message .id)

The code above, as said in the comment above will go page by page and will print messages (assuming we have 7 messages) as
Items on page 0
msg_1
msg_2
msg_3
Items on page 1
msg_4
msg_5
msg_6
Items on page 2
msg_7

[furoTmark]

Thanks for clarifying that, both examples are great!