BaggageBuilder Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Per request baggage builder
public class BaggageBuildertype BaggageBuilder = classPublic Class BaggageBuilder- Inheritance
-
BaggageBuilder
Remarks
Learn more about baggage attributes
Certification Requirements: To ensure the agent passes certification, the following properties must be set using their respective methods:
Scope-Specific Recommendations: The following properties are typically set at individual scopes and should be applied as appropriate:
- AgentId(String)
- AgentName(String)
- AgentDescription(String)
- AgenticUserId(String)
- AgenticUserEmail(String)
- AgentBlueprintId(String)
- UserId(String)
- UserEmail(String)
- UserName(String)
Learn more about certification requirements
Constructors
| Name | Description |
|---|---|
| BaggageBuilder() | |
Methods
| Name | Description |
|---|---|
| AgentBlueprintId(String) |
Sets the agent blueprint ID baggage value. |
| AgentDescription(String) |
Sets the agent description baggage value. |
| AgenticUserEmail(String) |
Sets the agentic user email baggage value. |
| AgenticUserId(String) |
Sets the agentic user ID baggage value. |
| AgentId(String) |
Sets the agent ID baggage value. |
| AgentName(String) |
Sets the agent name baggage value. |
| AgentPlatformId(String) |
Sets the agent platform ID baggage value. |
| AgentVersion(String) |
Sets the agent version baggage value. |
| Build() |
Applies the collected baggage to the current context. |
| ChannelLink(String) |
Sets the channel link baggage value. |
| ChannelName(String) |
Sets the channel name baggage value. |
| ConversationId(String) |
Sets the conversation ID baggage value. |
| ConversationItemLink(String) |
Sets the conversation item link baggage value. |
| InvokeAgentServer(String, Nullable<Int32>) |
Sets the invoke agent server address and port baggage values. |
| OperationSource(String) |
Sets the operation source baggage value. To be used with server spans to identify the source of the operation e.g(ACF, ATG) |
| SessionDescription(String) |
Sets the session description baggage value. |
| SessionId(String) |
Sets the session ID baggage value. |
| Set(String, String) |
Adds a baggage key/value if the value is not null or whitespace. |
| SetRange(IEnumerable<KeyValuePair<String,Object>>) |
Sets multiple baggage values from an enumerable of key-value pairs. |
| TenantId(String) |
Sets the tenant ID baggage value. |
| UserClientIp(IPAddress) |
Sets the user client IP baggage value. |
| UserEmail(String) |
Sets the user email baggage value. |
| UserId(String) |
Sets the user ID baggage value. |
| UserName(String) |
Sets the user name baggage value. |
Extension Methods
| Name | Description |
|---|---|
| FromTurnContext(BaggageBuilder, ITurnContext) |
Sets the baggage values from TurnContext. |
| FromTurnContext(BaggageBuilder, ITurnContext) |
Sets the baggage values from TurnContext. |
| SetCallerBaggage(BaggageBuilder, ITurnContext) |
Sets the caller-related baggage values from the TurnContext. |
| SetCallerBaggage(BaggageBuilder, ITurnContext) |
Sets the caller-related baggage values from the TurnContext. |
| SetChannelBaggage(BaggageBuilder, ITurnContext) |
Sets the channel baggage values from the TurnContext. |
| SetConversationIdBaggage(BaggageBuilder, ITurnContext) |
Sets the conversation ID and item link baggage values from the TurnContext. |
| SetConversationIdBaggage(BaggageBuilder, ITurnContext) |
Sets the conversation ID and item link baggage values from the TurnContext. |
| SetExecutionTypeBaggage(BaggageBuilder, ITurnContext) |
Sets the execution type baggage value based on caller and recipient agentic status. |
| SetSourceMetadataBaggage(BaggageBuilder, ITurnContext) |
Sets the source metadata baggage values from the TurnContext. |
| SetTargetAgentBaggage(BaggageBuilder, ITurnContext) |
Sets the target agent-related baggage values from the TurnContext. |
| SetTargetAgentBaggage(BaggageBuilder, ITurnContext) |
Sets the target agent-related baggage values from the TurnContext. |
| SetTenantIdBaggage(BaggageBuilder, ITurnContext) |
Sets the tenant ID baggage value, extracting from ChannelData if necessary. |
| SetTenantIdBaggage(BaggageBuilder, ITurnContext) |
Sets the tenant ID baggage value, extracting from ChannelData if necessary. |