Rename ChatThreadId to ConversationId (#46002)

gewarren · web-flow · commit e2b798059974 · 2025-05-14T11:35:55.000-04:00
diff --git a/docs/ai/microsoft-extensions-ai.md b/docs/ai/microsoft-extensions-ai.md
@@ -181,15 +181,15 @@ When working with a stateless service, callers maintain a list of all messages.
 
 :::code language="csharp" source="snippets/microsoft-extensions-ai/ConsoleAI.StatelessStateful/Program.cs" id="Snippet1":::
 
-For stateful services, you might already know the identifier used for the relevant conversation. You can put that identifier into <xref:Microsoft.Extensions.AI.ChatOptions.ChatThreadId?displayProperty=nameWithType>. Usage then follows the same pattern, except there's no need to maintain a history manually.
+For stateful services, you might already know the identifier used for the relevant conversation. You can put that identifier into <xref:Microsoft.Extensions.AI.ChatOptions.ConversationId?displayProperty=nameWithType>. Usage then follows the same pattern, except there's no need to maintain a history manually.
 
 :::code language="csharp" source="snippets/microsoft-extensions-ai/ConsoleAI.StatelessStateful/Program.cs" id="Snippet2":::
 
-Some services might support automatically creating a thread ID for a request that doesn't have one. In such cases, you can transfer the <xref:Microsoft.Extensions.AI.ChatResponse.ChatThreadId?displayProperty=nameWithType> over to the `ChatOptions.ChatThreadId` for subsequent requests. For example:
+Some services might support automatically creating a thread ID for a request that doesn't have one. In such cases, you can transfer the <xref:Microsoft.Extensions.AI.ChatResponse.ConversationId?displayProperty=nameWithType> over to the `ChatOptions.ConversationId` for subsequent requests. For example:
 
 :::code language="csharp" source="snippets/microsoft-extensions-ai/ConsoleAI.StatelessStateful/Program.cs" id="Snippet3":::
 
-If you don't know ahead of time whether the service is stateless or stateful, you can check the response <xref:Microsoft.Extensions.AI.ChatResponse.ChatThreadId> and act based on its value. If it's set, then that value is propagated to the options and the history is cleared so as to not resend the same history again. If the response `ChatThreadId` isn't set, then the response message is added to the history so that it's sent back to the service on the next turn.
+If you don't know ahead of time whether the service is stateless or stateful, you can check the response <xref:Microsoft.Extensions.AI.ChatResponse.ConversationId> and act based on its value. If it's set, then that value is propagated to the options and the history is cleared so as to not resend the same history again. If the response `ConversationId` isn't set, then the response message is added to the history so that it's sent back to the service on the next turn.
 
 :::code language="csharp" source="snippets/microsoft-extensions-ai/ConsoleAI.StatelessStateful/Program.cs" id="Snippet4":::
 
diff --git a/docs/ai/snippets/microsoft-extensions-ai/AI.Shared/AI.Shared.csproj b/docs/ai/snippets/microsoft-extensions-ai/AI.Shared/AI.Shared.csproj
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.AI" Version="9.4.0-preview.1.25207.5" />
+    <PackageReference Include="Microsoft.Extensions.AI" Version="9.4.4-preview.1.25259.16" />
     <PackageReference Include="System.Threading.RateLimiting" Version="10.0.0-preview.4.25258.110" />
   </ItemGroup>
 
diff --git a/docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.StatelessStateful/Program.cs b/docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.StatelessStateful/Program.cs
@@ -18,7 +18,7 @@
 // </Snippet1>
 
 // <Snippet2>
-ChatOptions statefulOptions = new() { ChatThreadId = "my-conversation-id" };
+ChatOptions statefulOptions = new() { ConversationId = "my-conversation-id" };
 while (true)
 {
     Console.Write("Q: ");
@@ -38,7 +38,7 @@
     ChatResponse response = await client.GetResponseAsync(message, options);
     Console.WriteLine(response);
 
-    options.ChatThreadId = response.ChatThreadId;
+    options.ConversationId = response.ConversationId;
 }
 // </Snippet3>
 
@@ -53,8 +53,8 @@
     ChatResponse response = await client.GetResponseAsync(chatHistory);
     Console.WriteLine(response);
 
-    chatOptions.ChatThreadId = response.ChatThreadId;
-    if (response.ChatThreadId is not null)
+    chatOptions.ConversationId = response.ConversationId;
+    if (response.ConversationId is not null)
     {
         chatHistory.Clear();
     }
diff --git a/docs/ai/snippets/microsoft-extensions-ai/ConsoleAI/ConsoleAI.csproj b/docs/ai/snippets/microsoft-extensions-ai/ConsoleAI/ConsoleAI.csproj
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.AI" Version="9.4.0-preview.1.25207.5" />
+    <PackageReference Include="Microsoft.Extensions.AI" Version="9.4.4-preview.1.25259.16" />
   </ItemGroup>
 
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`// </Snippet1>`
`19`	`19`
`20`	`20`	`// <Snippet2>`
`21`		`-ChatOptions statefulOptions = new() { ChatThreadId = "my-conversation-id" };`
	`21`	`+ChatOptions statefulOptions = new() { ConversationId = "my-conversation-id" };`
`22`	`22`	`while (true)`
`23`	`23`	`{`
`24`	`24`	`Console.Write("Q: ");`
`@@ -38,7 +38,7 @@`
`38`	`38`	`ChatResponse response = await client.GetResponseAsync(message, options);`
`39`	`39`	`Console.WriteLine(response);`
`40`	`40`
`41`		`- options.ChatThreadId = response.ChatThreadId;`
	`41`	`+ options.ConversationId = response.ConversationId;`
`42`	`42`	`}`
`43`	`43`	`// </Snippet3>`
`44`	`44`
`@@ -53,8 +53,8 @@`
`53`	`53`	`ChatResponse response = await client.GetResponseAsync(chatHistory);`
`54`	`54`	`Console.WriteLine(response);`
`55`	`55`
`56`		`- chatOptions.ChatThreadId = response.ChatThreadId;`
`57`		`- if (response.ChatThreadId is not null)`
	`56`	`+ chatOptions.ConversationId = response.ConversationId;`
	`57`	`+ if (response.ConversationId is not null)`
`58`	`58`	`{`
`59`	`59`	`chatHistory.Clear();`
`60`	`60`	`}`