[Azure.AI.Projects] URL Citations (Azure#48759)

* Update with typespec changes for assistant -> agent id. Update sample for url citation

Signed-off-by: trangevi <[email protected]>

* Test updates

Signed-off-by: trangevi <[email protected]>

* update changelog

Signed-off-by: trangevi <[email protected]>

* regen

Signed-off-by: trangevi <[email protected]>

* Changelog update

Signed-off-by: trangevi <[email protected]>

---------

Signed-off-by: trangevi <[email protected]>

Author: trangevi

sdk/ai/Azure.AI.Projects/CHANGELOG.md

@@ -1,16 +1,15 @@
 # Release History
 
-## 1.0.0-beta.5 (Unreleased)
+## 1.0.0-beta.5 (2025-03-13)
 
 ### Features Added
 
 * Added `ConnectionProvider` abstraction in `AIProjectClient` to enable seamless connectivity with Azure OpenAI, Inference, and Search SDKs.
+* Added support for URL citations with the `MessageTextUrlCitationAnnotation` class. `MessageTextContent` objects now can possibly have `Annotations` populated in order to provide information on URL citations.
 
 ### Breaking Changes
 
-### Bugs Fixed
-
-### Other Changes
+* `assistantId` has been renamed to `agentId` throughout the package.
 
 ## 1.0.0-beta.4 (2025-02-28)
 

sdk/ai/Azure.AI.Projects/README.md

@@ -87,7 +87,7 @@ AgentsClient client = new AgentsClient(connectionString, new DefaultAzureCredent
 With an authenticated client, an agent can be created:
 ```C# Snippet:OverviewCreateAgent
 Response<Agent> agentResponse = await client.CreateAgentAsync(
-    model: "gpt-4-1106-preview",
+    model: "gpt-4",
     name: "Math Tutor",
     instructions: "You are a personal math tutor. Write and run code to answer math questions.",
     tools: new List<ToolDefinition> { new CodeInterpreterToolDefinition() });
@@ -201,7 +201,7 @@ fileSearchToolResource.VectorStoreIds.Add(vectorStore.Id);
 
 // Create an agent with toolResources and process assistant run
 Response<Agent> agentResponse = await client.CreateAgentAsync(
-        model: "gpt-4-1106-preview",
+        model: "gpt-4",
         name: "SDK Test Agent - Retrieval",
         instructions: "You are a helpful agent that can help fetch data from files you know about.",
         tools: new List<ToolDefinition> { new FileSearchToolDefinition() },

sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.net8.0.cs

@@ -21,7 +21,7 @@ public partial class AgentsClient
     /// <see cref="Agent"/>.
     /// </summary>
     /// <param name="threadId"> Identifier of the thread. </param>
-    /// <param name="assistantId"> The ID of the agent that should run the thread. </param>
+    /// <param name="agentId"> The ID of the agent that should run the thread. </param>
     /// <param name="overrideModelName"> The overridden model name that the agent should use to run the thread. </param>
     /// <param name="overrideInstructions"> The overridden system instructions that the agent should use to run the thread. </param>
     /// <param name="additionalInstructions">
@@ -57,17 +57,17 @@ public partial class AgentsClient
     /// <param name="parallelToolCalls"> If `true` functions will run in parallel during tool use. </param>
     /// <param name="metadata"> A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. </param>
     /// <param name="cancellationToken"> The cancellation token to use. </param>
-    /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> or <paramref name="assistantId"/> is null. </exception>
+    /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> or <paramref name="agentId"/> is null. </exception>
     /// <exception cref="ArgumentException"> <paramref name="threadId"/> is an empty string, and was expected to be non-empty. </exception>
 #pragma warning disable AZC0015 // Unexpected client method return type.
-    public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string assistantId, string overrideModelName = null, string overrideInstructions = null, string additionalInstructions = null, IEnumerable<ThreadMessageOptions> additionalMessages = null, IEnumerable<ToolDefinition> overrideTools = null, float? temperature = null, float? topP = null, int? maxPromptTokens = null, int? maxCompletionTokens = null, TruncationObject truncationStrategy = null, BinaryData toolChoice = null, BinaryData responseFormat = null, bool? parallelToolCalls = null, IReadOnlyDictionary<string, string> metadata = null, CancellationToken cancellationToken = default)
+    public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string agentId, string overrideModelName = null, string overrideInstructions = null, string additionalInstructions = null, IEnumerable<ThreadMessageOptions> additionalMessages = null, IEnumerable<ToolDefinition> overrideTools = null, float? temperature = null, float? topP = null, int? maxPromptTokens = null, int? maxCompletionTokens = null, TruncationObject truncationStrategy = null, BinaryData toolChoice = null, BinaryData responseFormat = null, bool? parallelToolCalls = null, IReadOnlyDictionary<string, string> metadata = null, CancellationToken cancellationToken = default)
 #pragma warning restore AZC0015 // Unexpected client method return type.
     {
         Argument.AssertNotNullOrEmpty(threadId, nameof(threadId));
-        Argument.AssertNotNull(assistantId, nameof(assistantId));
+        Argument.AssertNotNull(agentId, nameof(agentId));
 
         CreateRunRequest createRunRequest = new CreateRunRequest(
-            assistantId,
+            agentId,
             overrideModelName,
             overrideInstructions,
             additionalInstructions,
@@ -97,7 +97,7 @@ async Task<Response> sendRequestAsync() =>
     /// <see cref="Agent"/>.
     /// </summary>
     /// <param name="threadId"> Identifier of the thread. </param>
-    /// <param name="assistantId"> The ID of the agent that should run the thread. </param>
+    /// <param name="agentId"> The ID of the agent that should run the thread. </param>
     /// <param name="overrideModelName"> The overridden model name that the agent should use to run the thread. </param>
     /// <param name="overrideInstructions"> The overridden system instructions that the agent should use to run the thread. </param>
     /// <param name="additionalInstructions">
@@ -133,17 +133,17 @@ async Task<Response> sendRequestAsync() =>
     /// <param name="parallelToolCalls"> If `true` functions will run in parallel during tool use. </param>
     /// <param name="metadata"> A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. </param>
     /// <param name="cancellationToken"> The cancellation token to use. </param>
-    /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> or <paramref name="assistantId"/> is null. </exception>
+    /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> or <paramref name="agentId"/> is null. </exception>
     /// <exception cref="ArgumentException"> <paramref name="threadId"/> is an empty string, and was expected to be non-empty. </exception>
 #pragma warning disable AZC0015 // Unexpected client method return type.
-    public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string assistantId, string overrideModelName = null, string overrideInstructions = null, string additionalInstructions = null, IEnumerable<ThreadMessageOptions> additionalMessages = null, IEnumerable<ToolDefinition> overrideTools = null, float? temperature = null, float? topP = null, int? maxPromptTokens = null, int? maxCompletionTokens = null, TruncationObject truncationStrategy = null, BinaryData toolChoice = null, BinaryData responseFormat = null, bool? parallelToolCalls = null, IReadOnlyDictionary<string, string> metadata = null, CancellationToken cancellationToken = default)
+    public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string agentId, string overrideModelName = null, string overrideInstructions = null, string additionalInstructions = null, IEnumerable<ThreadMessageOptions> additionalMessages = null, IEnumerable<ToolDefinition> overrideTools = null, float? temperature = null, float? topP = null, int? maxPromptTokens = null, int? maxCompletionTokens = null, TruncationObject truncationStrategy = null, BinaryData toolChoice = null, BinaryData responseFormat = null, bool? parallelToolCalls = null, IReadOnlyDictionary<string, string> metadata = null, CancellationToken cancellationToken = default)
 #pragma warning restore AZC0015 // Unexpected client method return type.
     {
         Argument.AssertNotNullOrEmpty(threadId, nameof(threadId));
-        Argument.AssertNotNull(assistantId, nameof(assistantId));
+        Argument.AssertNotNull(agentId, nameof(agentId));
 
         CreateRunRequest createRunRequest = new CreateRunRequest(
-            assistantId,
+            agentId,
             overrideModelName,
             overrideInstructions,
             additionalInstructions,