.NET: Error when Streaming and agent name has a blankspace and tools are provided

[luismanez]

If you create an Agent with tools, and the Agent Name contains a blank space, and you invoke the streaming method, it fails with the error below.

If you don't pass tools, it works fine, even if the agent name contains a blank space.
If your AgentName does not contain a blank space, it works fine.
When not using streaming, all works fine.

So, with this code, it fails:

AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
     .GetChatClient(deploymentName)
     .CreateAIAgent(
        instructions: "You are a helpful assistant",
        name: "My Agent",
        tools: [AIFunctionFactory.Create(GetWeather)]);

but this code works:

AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
     .GetChatClient(deploymentName)
     .CreateAIAgent(
        instructions: "You are a helpful assistant",
        name: "MyAgent",
        tools: [AIFunctionFactory.Create(GetWeather)]);

Unhandled exception. System.ClientModel.ClientResultException: HTTP 400 (invalid_request_error: invalid_value)
Parameter: messages[2].name

Invalid 'messages[2].name': string does not match pattern. Expected a string that matches the pattern '^[^\s<|\\/>]+$'.
   at Azure.AI.OpenAI.ClientPipelineExtensions.ProcessMessageAsync(ClientPipeline pipeline, PipelineMessage message, RequestOptions options)
   at Azure.AI.OpenAI.Chat.AzureChatClient.CompleteChatAsync(BinaryContent content, RequestOptions options)
   at OpenAI.Chat.ChatClient.<>c__DisplayClass17_0.<<CompleteChatStreamingAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at OpenAI.AsyncSseUpdateCollection`1.GetRawPagesAsync()+MoveNext()
   at OpenAI.AsyncSseUpdateCollection`1.GetRawPagesAsync()+System.Threading.Tasks.Sources.IValueTaskSource<System.Boolean>.GetResult()

Guess for some reason, when using streaming, the returned response is unexpected when combining tools and agent name contains a blank space (and maybe some other special char)

Happy to help if you want me to test something.

Thanks!

[stephentoub]

I think this should be addressed by dotnet/extensions#6827, which is in the latest build of Microsoft.Extensions.AI.OpenAI on nuget, but Microsoft.Agents.AI.OpenAI references the previous build (that should be addressed this week hopefully). Can you try adding to your project an explicit package reference to the newer version and see if that fixes it?
https://www.nuget.org/packages/Microsoft.Extensions.AI.OpenAI/9.9.1-preview.1.25474.6

That said, I'm surprised non-streaming doesn't have the same issue, so maybe there's something else lurking.

[luismanez]

boom! ... it worked!!! ... thanks a lot @stephentoub
and I double checked it only fails when streaming (yeah, weird)

[stephentoub]

@markwallace-microsoft, one more reason to upgrade to the latest OpenAI asap (the whole Azure.AI.OpenAI version conflict issue)