InvokeAgentScope class

Pakke:

@microsoft/agents-a365-observability

Gir OpenTelemetry sporingsomfang for aktiveringsoperasjoner for AI-agent.

Utvider

OpenTelemetryScope

Metoder

recordInputMessages(InputMessagesParam)	Registrerer inndatameldingene for telemetrisporing. Godtar en enkelt streng, en matrise med strenger (automatisk pakket som OTEL ChatMessage med rolle user), eller en versjon av InputMessages wrapper.
recordOutputMessages(OutputMessagesParam)	Registrerer utdatameldingene for telemetrisporing. Godtar én enkelt streng, en matrise med strenger (automatisk pakket som OTEL OutputMessage med rolle assistant) eller en versjonsbasert Wrapper for OutputMessages.
recordResponse(string)	Registrerer svarinformasjon for telemetrisporing.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Oppretter og starter et nytt område for sporing av agentinnkallelse.

Arvede metoder

dispose()	Eldre fjerningsmetode for kompatibilitet
getSpanContext()	Henter span-konteksten for dette omfanget. Dette kan brukes til å opprette en ParentSpanRef for eksplisitt overordnet-underordnet kobling på tvers av aynkrone grenser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerer flere attributtnøkkel-/verdipar for telemetrisporing.
recordCancellation(string)	Registrerer en avlysningshendelse i tidsrommet. Angir span-statusen til ERROR med årsaken til kanselleringen, og merker feiltypen som TaskCanceledException.
recordError(Error)	Registrerer en feil som oppstod under operasjonen
setEndTime(TimeInput)	Angir et egendefinert sluttidspunkt for omfanget. Når den er angitt, sendes denne verdien til i stedet for å span.end() bruke gjeldende veggklokketid. Dette er nyttig når det faktiske sluttidspunktet for operasjonen er kjent før omfanget fjernes.
withActiveSpanAsync<T>(() => Promise<T>)	Gjør dette tidsrommet aktivt for varigheten av den aynkrone tilbakeringingskjøringen

Metodedetaljer

recordInputMessages(InputMessagesParam)

Registrerer inndatameldingene for telemetrisporing. Godtar en enkelt streng, en matrise med strenger (automatisk pakket som OTEL ChatMessage med rolle user), eller en versjon av InputMessages wrapper.

function recordInputMessages(messages: InputMessagesParam)

Parametere

messages

InputMessagesParam

En streng, matrise med strenger eller en InputMessages wrapper

recordOutputMessages(OutputMessagesParam)

Registrerer utdatameldingene for telemetrisporing. Godtar én enkelt streng, en matrise med strenger (automatisk pakket som OTEL OutputMessage med rolle assistant) eller en versjonsbasert Wrapper for OutputMessages.

function recordOutputMessages(messages: OutputMessagesParam)

Parametere

messages

OutputMessagesParam

En streng, matrise med strenger eller en Wrapper for OutputMessages

recordResponse(string)

Registrerer svarinformasjon for telemetrisporing.

function recordResponse(response: string)

Parametere

response

string

Aktiveringssvaret

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

Oppretter og starter et nytt område for sporing av agentinnkallelse.

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

Parametere

request

Request

Be om nyttelast (kanal, conversationId, innhold, økt-ID).

invokeScopeDetails

InvokeAgentScopeDetails

Detaljer på omfangsnivå

agentDetails

AgentDetails

Agentidentiteten. Leier-ID er avledet fra agentDetails.tenantId (obligatorisk).

callerDetails

CallerDetails

Valgfri anroperinformasjon. Støtter tre scenarier:

• Bare menneskelig innringer: { userDetails: { userId, userName, ... } }
• Bare agentoppringer: { callerAgentDetails: { agentId, agentName, ... } }
• Begge (A2A med menneske i kjede): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

Valgfri span-konfigurasjon (parentContext, startTime, endTime, spanKind, spanLinks).

Returnerer

InvokeAgentScope

En ny InvokeAgentScope-forekomst.

Arvede metodedetaljer

dispose()

Eldre fjerningsmetode for kompatibilitet

function dispose()

Arvet fraOpenTelemetryScope.dispose

getSpanContext()

Henter span-konteksten for dette omfanget. Dette kan brukes til å opprette en ParentSpanRef for eksplisitt overordnet-underordnet kobling på tvers av aynkrone grenser.

function getSpanContext(): SpanContext

Returnerer

SpanContext

SpanContext som inneholder traceId og spanId

Arvet fraOpenTelemetryScope.getSpanContext

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

Registrerer flere attributtnøkkel-/verdipar for telemetrisporing.

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

Parametere

attributes

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

Samling av attributtnøkkel-/verdipar (matrise eller iterbar for [nøkkel, verdi] eller objektkart).

Arvet fraOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registrerer en avlysningshendelse i tidsrommet. Angir span-statusen til ERROR med årsaken til kanselleringen, og merker feiltypen som TaskCanceledException.

function recordCancellation(reason?: string)

Parametere

reason

string

Valgfri annulleringsårsak. Standardinnstillingene for «Oppgaven ble avbrutt».

Arvet fraOpenTelemetryScope.recordCancellation

recordError(Error)

Registrerer en feil som oppstod under operasjonen

function recordError(error: Error)

Parametere

error

Error

Feilen som oppstod

Arvet fraOpenTelemetryScope.recordError

setEndTime(TimeInput)

Angir et egendefinert sluttidspunkt for omfanget. Når den er angitt, sendes denne verdien til i stedet for å span.end() bruke gjeldende veggklokketid. Dette er nyttig når det faktiske sluttidspunktet for operasjonen er kjent før omfanget fjernes.

function setEndTime(endTime: TimeInput)

Parametere

endTime

TimeInput

Sluttidspunktet som millisekunder siden epoke, dato eller hrtime tuppel.

Arvet fraOpenTelemetryScope.setEndTime

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

Gjør dette tidsrommet aktivt for varigheten av den aynkrone tilbakeringingskjøringen

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

Parametere

callback

() => Promise<T>

Returnerer

Promise<T>

Arvet fraOpenTelemetryScope.withActiveSpanAsync