InvokeAgentScope class

Paketti:

@microsoft/agents-a365-observability

Tarjoaa OpenTelemetry-jäljitysalueen tekoälyagentin kutsutoiminnoille.

Ulottuu

OpenTelemetryScope

Menetelmät

recordInputMessages(InputMessagesParam)	Kirjaa telemetrian seurantaa varten lähetetyt syöteviestit. Hyväksyy yksittäisen merkkijonon, merkkijonomatriisin (automaattisen rivityksen OTEL ChatMessage -nimellä roolilla user) tai versiollisen InputMessages-rivittimen.
recordOutputMessages(OutputMessagesParam)	Kirjaa telemetrian seurannan tulosviestit. Hyväksyy yksittäisen merkkijonon, merkkijonomatriisin (automaattinen paketointi OTEL OutputMessage -nimellä roolilla assistant) tai versiollisen OutputMessages-rivityksen.
recordResponse(string)	Kirjaa vastaustiedot telemetrian seurantaa varten.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Luo ja käynnistää uuden vaikutusalueen agentin kutsujen seurannalle.

Perityt menetelmät

dispose()	Vanha hävitysmenetelmä yhteensopivuuden vuoksi
getSpanContext()	Hakee alueen span-kontekstin. Tämän avulla voidaan luoda ParentSpanRef eksplisiittistä pää-alikohde-linkkiä varten asynkronisten rajojen yli.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Tallentaa useita määriteavain-/arvo-pareja telemetrian seurantaa varten.
recordCancellation(string)	Kirjaa peruuttamistapahtuma ajanjakson aikana. Määrittää tilan ERROR peruuttamisen syyksi ja merkitsee virhetyypiksi "TaskCanceledException".
recordError(Error)	Kirjaa toiminnon aikana ilmennyt virhe
setEndTime(TimeInput)	Määrittää vaikutusalueen mukautetun päättymisajan. Kun asetus on määritetty, hävitys siirtää tämän arvon kohteeseen span.end() nykyisen seinäkellonajan käyttämisen sijaan. Tästä on hyötyä, kun toiminnon todellinen päättymisaika on tiedossa, ennen kuin vaikutusalue on hävitetty.
withActiveSpanAsync<T>(() => Promise<T>)	Tekee tästä ulottumisesta aktiivisen asynkronisen takaisinkutsun suorituksen ajaksi

Menetelmän tiedot

recordInputMessages(InputMessagesParam)

Kirjaa telemetrian seurantaa varten lähetetyt syöteviestit. Hyväksyy yksittäisen merkkijonon, merkkijonomatriisin (automaattisen rivityksen OTEL ChatMessage -nimellä roolilla user) tai versiollisen InputMessages-rivittimen.

function recordInputMessages(messages: InputMessagesParam)

Parametrit

messages

InputMessagesParam

Merkkijono, merkkijonomatriisi tai InputMessages-rivitys

recordOutputMessages(OutputMessagesParam)

Kirjaa telemetrian seurannan tulosviestit. Hyväksyy yksittäisen merkkijonon, merkkijonomatriisin (automaattinen paketointi OTEL OutputMessage -nimellä roolilla assistant) tai versiollisen OutputMessages-rivityksen.

function recordOutputMessages(messages: OutputMessagesParam)

Parametrit

messages

OutputMessagesParam

Merkkijono, merkkijonomatriisi tai OutputMessages-rivitys

recordResponse(string)

Kirjaa vastaustiedot telemetrian seurantaa varten.

function recordResponse(response: string)

Parametrit

response

string

Kutsuvastaus

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

Luo ja käynnistää uuden vaikutusalueen agentin kutsujen seurannalle.

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

Parametrit

request

Request

Pyynnön tiedot (kanava, keskustelun tunnus, sisältö, istunnon tunnus).

invokeScopeDetails

InvokeAgentScopeDetails

Vaikutusaluetason tiedot

agentDetails

AgentDetails

Agentin henkilöllisyys. Vuokraajatunnus johdetaan kohteesta agentDetails.tenantId (pakollinen).

callerDetails

CallerDetails

Valinnaiset soittajan tiedot. Tukee kolmea skenaariota:

• Vain ihmissoittaja: { userDetails: { userId, userName, ... } }
• Vain agentin soittaja: { callerAgentDetails: { agentId, agentName, ... } }
• Molemmat (A2A, jonka ketjussa on ihminen): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

Valinnainen span configuration (parentContext, startTime, endTime, spanKind, spanLinks).

Palautukset

InvokeAgentScope

Uusi InvokeAgentScope-esiintymä.

Perityn menetelmän tiedot

dispose()

Vanha hävitysmenetelmä yhteensopivuuden vuoksi

function dispose()

PerittyOpenTelemetryScope.dispose-ominaisuudesta

getSpanContext()

Hakee alueen span-kontekstin. Tämän avulla voidaan luoda ParentSpanRef eksplisiittistä pää-alikohde-linkkiä varten asynkronisten rajojen yli.

function getSpanContext(): SpanContext

Palautukset

SpanContext

SpanContext, joka sisältää traceId-tunnuksen ja spanId-arvon

PerittyKohteesta OpenTelemetryScope.getSpanContext

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

Tallentaa useita määriteavain-/arvo-pareja telemetrian seurantaa varten.

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

Parametrit

attributes

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

Määriteavain-/arvoparien kokoelma (matriisi tai kohteen [avain, arvo] tai objektikartta iterable).

Peritty kohteestaOpenTelemetryScope.recordAttributes

recordCancellation(string)

Kirjaa peruuttamistapahtuma ajanjakson aikana. Määrittää tilan ERROR peruuttamisen syyksi ja merkitsee virhetyypiksi "TaskCanceledException".

function recordCancellation(reason?: string)

Parametrit

reason

string

Valinnainen peruutussyy. Oletusarvo on "Tehtävän peruutettu".

Perittykohteesta OpenTelemetryScope.recordCancellation

recordError(Error)

Kirjaa toiminnon aikana ilmennyt virhe

function recordError(error: Error)

Parametrit

error

Error

Tapahtunut virhe

PerittyOpenTelemetryScope.recordError-kohteesta

setEndTime(TimeInput)

Määrittää vaikutusalueen mukautetun päättymisajan. Kun asetus on määritetty, hävitys siirtää tämän arvon kohteeseen span.end() nykyisen seinäkellonajan käyttämisen sijaan. Tästä on hyötyä, kun toiminnon todellinen päättymisaika on tiedossa, ennen kuin vaikutusalue on hävitetty.

function setEndTime(endTime: TimeInput)

Parametrit

endTime

TimeInput

Tämä on päättymisaika millisekunteina aikakaudesta, päivämäärästä tai hrtime-monikkosta.

Perittykohteesta OpenTelemetryScope.setEndTime

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

Tekee tästä ulottumisesta aktiivisen asynkronisen takaisinkutsun suorituksen ajaksi

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

Parametrit

callback

() => Promise<T>

Palautukset

Promise<T>

PerittyOpenTelemetryScope.withActiveSpanAsync