Class ScopeUtils

Unified utilities to populate scope tags from a TurnContext.

Index

Constructors

Methods

buildInvokeAgentDetails deriveAgentDetails deriveCallerAgent deriveCallerDetails deriveChannelObject deriveConversationId populateExecuteToolScopeFromTurnContext populateInferenceScopeFromTurnContext populateInvokeAgentScopeFromTurnContext

Constructors

constructor

new ScopeUtils(): ScopeUtils
Returns ScopeUtils

Methods

`Static`buildInvokeAgentDetails

buildInvokeAgentDetails(
    details: AgentDetails,
    turnContext: TurnContextLike,
    authToken: string,
): AgentDetails
Build agent details by merging provided details with TurnContext.
Parameters
- details: AgentDetails
- turnContext: TurnContextLike
- authToken: string
Returns AgentDetails
- Defined in a365/hosting/scopeUtils.ts:196

`Static`deriveAgentDetails

deriveAgentDetails(
turnContext: TurnContextLike,
authToken: string,
): AgentDetails | undefined
Derive target agent details from the activity recipient.
Parameters
- turnContext: TurnContextLike
- authToken: string
Returns AgentDetails | undefined
- Defined in a365/hosting/scopeUtils.ts:34

`Static`deriveCallerAgent

deriveCallerAgent(turnContext: TurnContextLike): AgentDetails | undefined
Derive caller agent details from the activity from.
Parameters
- turnContext: TurnContextLike
Returns AgentDetails | undefined
- Defined in a365/hosting/scopeUtils.ts:55

`Static`deriveCallerDetails

deriveCallerDetails(turnContext: TurnContextLike): UserDetails | undefined
Derive caller identity details (id, email, name, tenant) from the activity from.
Parameters
- turnContext: TurnContextLike
Returns UserDetails | undefined
- Defined in a365/hosting/scopeUtils.ts:72

`Static`deriveChannelObject

deriveChannelObject(
turnContext: TurnContextLike,
): { description?: string; name?: string }
Derive channel (name and description) from the TurnContext.
Parameters
- turnContext: TurnContextLike
Returns { description?: string; name?: string }
- Defined in a365/hosting/scopeUtils.ts:93

`Static`deriveConversationId

deriveConversationId(turnContext: TurnContextLike): string | undefined
Derive conversation id from the TurnContext.
Parameters
- turnContext: TurnContextLike
Returns string | undefined
- Defined in a365/hosting/scopeUtils.ts:86

`Static`populateExecuteToolScopeFromTurnContext

populateExecuteToolScopeFromTurnContext(
    details: ToolCallDetails,
    turnContext: TurnContextLike,
    authToken: string,
    startTime?: TimeInput,
    endTime?: TimeInput,
    spanKind?: SpanKind,
): ExecuteToolScope
Create an ExecuteToolScope enriched with values from the TurnContext.
Parameters
- details: ToolCallDetails
- turnContext: TurnContextLike
- authToken: string
- OptionalstartTime: TimeInput
- OptionalendTime: TimeInput
- OptionalspanKind: SpanKind
Returns ExecuteToolScope
- Defined in a365/hosting/scopeUtils.ts:219

`Static`populateInferenceScopeFromTurnContext

populateInferenceScopeFromTurnContext(
    details: InferenceDetails,
    turnContext: TurnContextLike,
    authToken: string,
    startTime?: TimeInput,
    endTime?: TimeInput,
): InferenceScope
Create an InferenceScope enriched with values from the TurnContext.
Parameters
- details: InferenceDetails
- turnContext: TurnContextLike
- authToken: string
- OptionalstartTime: TimeInput
- OptionalendTime: TimeInput
Returns InferenceScope
- Defined in a365/hosting/scopeUtils.ts:117

`Static`populateInvokeAgentScopeFromTurnContext

populateInvokeAgentScopeFromTurnContext(
    details: AgentDetails,
    scopeDetails: InvokeAgentScopeDetails,
    turnContext: TurnContextLike,
    authToken: string,
    startTime?: TimeInput,
    endTime?: TimeInput,
    spanKind?: SpanKind,
): InvokeAgentScope
Create an InvokeAgentScope enriched with values from the TurnContext.
Parameters
- details: AgentDetails
- scopeDetails: InvokeAgentScopeDetails
- turnContext: TurnContextLike
- authToken: string
- OptionalstartTime: TimeInput
- OptionalendTime: TimeInput
- OptionalspanKind: SpanKind
Returns InvokeAgentScope
- Defined in a365/hosting/scopeUtils.ts:152