InvokeAgentScope class

Pakke:

@microsoft/agents-a365-observability

Leverer sporingsområdet for OpenTelemetry for aktiveringshandlinger for AI-agenten.

Udvider

OpenTelemetryScope

Metoder

recordInputMessages(InputMessagesParam)	Registrerer inputmeddelelserne til telemetrisporing. Accepterer en enkelt streng, en matrix af strenge (automatisk ombrudt som OTEL ChatMessage med rolle user) eller en versiongivet InputMessages-ombrydning.
recordOutputMessages(OutputMessagesParam)	Registrerer outputmeddelelserne til telemetrisporing. Accepterer en enkelt streng, en matrix af strenge (automatisk ombrudt som OTEL OutputMessage med rolle assistant) eller en versiongivet OutputMessages-ombrydning.
recordResponse(string)	Registrerer svaroplysninger til telemetrisporing.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Opretter og starter et nyt område for agentaktiveringssporing.

Nedarvede metoder

dispose()	Ældre metode til fjernelse af kompatibilitet
getSpanContext()	Henter omfangets kontekst for dette område. Dette kan bruges til at oprette en ParentSpanRef til eksplicit overordnet/underordnet-sammenkædning på tværs af asynkrone grænser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerer flere attributnøgle-/værdipar til telemetrisporing.
recordCancellation(string)	Registrerer en annulleringshændelse på området. Angiver status for span til ERROR med annulleringsårsagen og markerer fejltypen som 'TaskCanceledException'.
recordError(Error)	Registrerer en fejl, der opstod under handlingen
setEndTime(TimeInput)	Angiver et brugerdefineret sluttidspunkt for området. Når den er indstillet, overføres denne værdi til i stedet for at span.end() bruge det aktuelle vægklokkeslæt. Dette er nyttigt, når det faktiske sluttidspunkt for handlingen er kendt, før området fjernes.
withActiveSpanAsync<T>(() => Promise<T>)	Gør dette tidsrum aktivt i varigheden af den asynkrone tilbagekaldskørsel

Oplysninger om metode

recordInputMessages(InputMessagesParam)

Registrerer inputmeddelelserne til telemetrisporing. Accepterer en enkelt streng, en matrix af strenge (automatisk ombrudt som OTEL ChatMessage med rolle user) eller en versiongivet InputMessages-ombrydning.

function recordInputMessages(messages: InputMessagesParam)

Parametre

messages

InputMessagesParam

En streng, en matrix af strenge eller en InputMessages-ombrydning

recordOutputMessages(OutputMessagesParam)

Registrerer outputmeddelelserne til telemetrisporing. Accepterer en enkelt streng, en matrix af strenge (automatisk ombrudt som OTEL OutputMessage med rolle assistant) eller en versiongivet OutputMessages-ombrydning.

function recordOutputMessages(messages: OutputMessagesParam)

Parametre

messages

OutputMessagesParam

En streng, en matrix af strenge eller en OutputMessages-ombrydning

recordResponse(string)

Registrerer svaroplysninger til telemetrisporing.

function recordResponse(response: string)

Parametre

response

string

Aktiveringssvaret

start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)

Opretter og starter et nyt område for agentaktiveringssporing.

static function start(request: Request, invokeScopeDetails: InvokeAgentScopeDetails, agentDetails: AgentDetails, callerDetails?: CallerDetails, spanDetails?: SpanDetails): InvokeAgentScope

Parametre

request

Request

Anmod om nyttedata (kanal, samtale-id, indhold, sessionId).

invokeScopeDetails

InvokeAgentScopeDetails

Oplysninger på områdeniveau

agentDetails

AgentDetails

Agentens identitet. Lejer-id'et er afledt af agentDetails.tenantId (påkrævet).

callerDetails

CallerDetails

Valgfrie opkaldsoplysninger. Understøtter tre scenarier:

• Kun person, der ringer op: { userDetails: { userId, userName, ... } }
• Kun agentopkald: { callerAgentDetails: { agentId, agentName, ... } }
• Begge (A2A med mennesker i kæde): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

Valgfri konfiguration af span (parentContext, startTime, endTime, spanKind, spanLinks).

Returnerer

InvokeAgentScope

En ny InvokeAgentScope-forekomst.

Oplysninger om nedarvede metoder

dispose()

Ældre metode til fjernelse af kompatibilitet

function dispose()

Nedarvet fraOpenTelemetryScope.dispose

getSpanContext()

Henter omfangets kontekst for dette område. Dette kan bruges til at oprette en ParentSpanRef til eksplicit overordnet/underordnet-sammenkædning på tværs af asynkrone grænser.

function getSpanContext(): SpanContext

Returnerer

SpanContext

SpanContext, der indeholder traceId og spanId

Nedarvet fraOpenTelemetryScope.getSpanContext

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Registrerer flere attributnøgle-/værdipar til telemetrisporing.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Parametre

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

Samling af attributnøgle-/værdipar (matrix eller iterbar af [nøgle, værdi] eller objekttilknytning).

Nedarvet fraOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registrerer en annulleringshændelse på området. Angiver status for span til ERROR med annulleringsårsagen og markerer fejltypen som 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parametre

reason

string

Valgfri årsag til annullering. Som standard er "Opgaven blev annulleret".

Nedarvet fraOpenTelemetryScope.recordCancellation

recordError(Error)

Registrerer en fejl, der opstod under handlingen

function recordError(error: Error)

Parametre

error

Error

Den fejl, der opstod

Nedarvet fraOpenTelemetryScope.recordError

setEndTime(TimeInput)

Angiver et brugerdefineret sluttidspunkt for området. Når den er indstillet, overføres denne værdi til i stedet for at span.end() bruge det aktuelle vægklokkeslæt. Dette er nyttigt, når det faktiske sluttidspunkt for handlingen er kendt, før området fjernes.

function setEndTime(endTime: TimeInput)

Parametre

endTime

TimeInput

Sluttidspunktet som millisekunder siden epoken, en dato eller en TTime-tupel.

Nedarvet fraOpenTelemetryScope.setEndTime

withActiveSpanAsync<T>(() => Promise<T>)

Gør dette tidsrum aktivt i varigheden af den asynkrone tilbagekaldskørsel

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

Parametre

callback

() => Promise<T>

Returnerer

Promise<T>

Nedarvet fraOpenTelemetryScope.withActiveSpanAsync