BaggageBuilder Klasse

Pro Anfrage Gepäck-Generator.

Diese Klasse bietet eine Fluent-API zum Festlegen von Gepäckwerten, die im OpenTelemetry-Kontext weitergegeben werden.

Konstruktor

BaggageBuilder()

Beispiele


   builder = (BaggageBuilder()
              .tenant_id("tenant-123")
              .agent_id("agent-456"))

   with builder.build():
       # Baggage is set in this context
       pass
   # Baggage is restored after exiting the context

Methoden

__init__

Initialisieren Sie den Gepäckbauer.
__new__
agent_blueprint_id

Legen Sie den Gepäckwert für die Agent-Blueprint-ID fest.
agent_description

Legen Sie den Gepäckwert für die Agentbeschreibung fest.
agent_id

Legen Sie den Gepäckwert für die Agent-ID fest.
agent_name

Legen Sie den Gepäckwert für den Agentennamen fest.
agent_version

Legen Sie den Gepäckwert für die Agentversion fest.
agentic_user_email

Legen Sie den Wert für agentische Benutzer-E-Mail-Gepäck fest.
agentic_user_id

Legen Sie den agentischen Benutzer-ID-Gepäckwert fest.
build

Wenden Sie das gesammelte Gepäck auf den aktuellen Kontext an.
channel_links

Legt den Kanallink-Gepäckwert fest.
channel_name

Legt den Gepäckwert des Kanalnamens fest (z. B. "Teams", "msteams").
conversation_id

Legen Sie den Gepäckwert der Unterhaltungs-ID fest.
conversation_item_link

Legen Sie den Link-Gepäckwert für Unterhaltungsartikel fest.
invoke_agent_server

Legen Sie die Adresse und die Portgepäckwerte für den Aufruf-Agent-Server fest.
operation_source

Legen Sie den Gepäckwert für den Betrieb fest.

Dadurch wird der Name des Diensts mithilfe des SDK erfasst.
session_description

Legen Sie den Gepäckwert der Sitzungsbeschreibung fest.
session_id

Legen Sie den Sitzungs-ID-Gepäckwert fest.
set_pairs

Akzeptieren Sie diktieren oder iterierbar von (k,v).
tenant_id

Legen Sie den Gepäckwert der Mandanten-ID fest.
user_client_ip

Legen Sie den IP-Gepäckwert des Benutzerclients fest.
user_email

Legen Sie den E-Mail-Gepäckwert des Benutzers fest.
user_id

Legen Sie den Gepäckwert der Benutzer-ID fest.
user_name

Legen Sie den Gepäckwert für den Benutzernamen fest.

__init__

Initialisieren Sie den Gepäckbauer.

__init__()

__new__ 

__new__(**kwargs)

agent_blueprint_id

Legen Sie den Gepäckwert für die Agent-Blueprint-ID fest.

agent_blueprint_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Die Agent-Blueprint-ID

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

agent_description

Legen Sie den Gepäckwert für die Agentbeschreibung fest.

agent_description(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

agent_id

Legen Sie den Gepäckwert für die Agent-ID fest.

agent_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Die Agenten-ID

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

agent_name

Legen Sie den Gepäckwert für den Agentennamen fest.

agent_name(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

agent_version

Legen Sie den Gepäckwert für die Agentversion fest.

agent_version(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

agentic_user_email

Legen Sie den Wert für agentische Benutzer-E-Mail-Gepäck fest.

agentic_user_email(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Die agentische Benutzer-E-Mail

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

agentic_user_id

Legen Sie den agentischen Benutzer-ID-Gepäckwert fest.

agentic_user_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Die agentische Benutzer-ID

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

build

Wenden Sie das gesammelte Gepäck auf den aktuellen Kontext an.

build() -> BaggageScope

Gibt zurück

Typ Beschreibung
BaggageScope

Ein Kontextmanager, der das vorherige Gepäck beim Verlassen wiederhergestellt

Legt den Kanallink-Gepäckwert fest.

channel_links(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

channel_name

Legt den Gepäckwert des Kanalnamens fest (z. B. "Teams", "msteams").

channel_name(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

conversation_id

Legen Sie den Gepäckwert der Unterhaltungs-ID fest.

conversation_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

Legen Sie den Link-Gepäckwert für Unterhaltungsartikel fest.

conversation_item_link(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

invoke_agent_server

Legen Sie die Adresse und die Portgepäckwerte für den Aufruf-Agent-Server fest.

invoke_agent_server(address: str | None, port: int | None = None) -> BaggageBuilder

Parameter

Name Beschreibung
address
Erforderlich
str | None

Die Serveradresse (Hostname) des Ziel-Agent-Diensts.
port
int | None

Optionaler Serverport. Wird nur aufgezeichnet, wenn es sich von 443 unterscheidet.

Standardwert: None

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

operation_source

Legen Sie den Gepäckwert für den Betrieb fest.

Dadurch wird der Name des Diensts mithilfe des SDK erfasst.

operation_source(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Der Dienstname (z. B. "my-agent-service", "weather-bot")

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

session_description

Legen Sie den Gepäckwert der Sitzungsbeschreibung fest.

session_description(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

session_id

Legen Sie den Sitzungs-ID-Gepäckwert fest.

session_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

set_pairs

Akzeptieren Sie diktieren oder iterierbar von (k,v).

set_pairs(pairs: Any) -> BaggageBuilder

Parameter

Name Beschreibung
pairs
Erforderlich
Any

Gibt zurück

Typ Beschreibung
BaggageBuilder

tenant_id

Legen Sie den Gepäckwert der Mandanten-ID fest.

tenant_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Die Mandanten-ID

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

user_client_ip

Legen Sie den IP-Gepäckwert des Benutzerclients fest.

user_client_ip(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

user_email

Legen Sie den E-Mail-Gepäckwert des Benutzers fest.

user_email(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder

user_id

Legen Sie den Gepäckwert der Benutzer-ID fest.

user_id(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Die Benutzer-ID

Gibt zurück

Typ Beschreibung
BaggageBuilder

Self for method chaining

user_name

Legen Sie den Gepäckwert für den Benutzernamen fest.

user_name(value: str | None) -> BaggageBuilder

Parameter

Name Beschreibung
value
Erforderlich
str | None

Gibt zurück

Typ Beschreibung
BaggageBuilder