Compartilhar via


BaggageBuilder Classe

Construtor de bagagem por solicitação.

Essa classe fornece uma API fluente para definir valores de bagagem que serão propagados no contexto OpenTelemetry.

Inicialize o construtor de bagagem.

Construtor

BaggageBuilder()

Exemplos


>>> with BaggageBuilder()         ...     .tenant_id("tenant-123")         ...     .agent_id("agent-456")         ...     .correlation_id("corr-789")         ...     .build():
...     # Baggage is set in this context
...     pass
>>> # Baggage is restored after exiting the context

Métodos

agent_auid

Defina o valor da bagagem AUID do agente.

agent_blueprint_id

Defina o valor da bagagem da ID do blueprint do agente.

agent_description

Defina o valor da bagagem de descrição do agente.

agent_id

Defina o valor da bagagem da ID do agente.

agent_name

Defina o valor da bagagem do nome do agente.

agent_upn

Defina o valor da bagagem UPN do agente.

build

Aplique a bagagem coletada ao contexto atual.

caller_id

Defina o valor da bagagem da ID do chamador.

caller_name

Defina o valor da bagagem do nome do chamador.

caller_upn

Defina o valor da bagagem UPN do chamador.

conversation_id

Defina o valor da bagagem da ID da conversa.

conversation_item_link

Defina o valor da bagagem do link do item de conversa.

correlation_id

Defina o valor da bagagem da ID de correlação.

from_turn_context

Preencha a bagagem de um turn_context (tipo pato). Delega para baggage_turn_context.from_turn_context.

hiring_manager_id

Defina o valor da bagagem da ID do gerente de contratação.

operation_source

Defina o valor da bagagem de origem da operação.

set_pairs

Aceitar ditado ou iterável de (k,v).

set_request_context

Método de conveniência para iniciar um escopo de bagagem de solicitação com campos comuns.

source_metadata_description

Defina a descrição dos metadados de origem da execução (por exemplo, descrição do canal).

source_metadata_id

Defina a ID de metadados de origem da execução (por exemplo, ID do canal).

source_metadata_name

Defina o nome dos metadados de origem da execução (por exemplo, nome do canal).

tenant_id

Defina o valor da bagagem da ID do locatário.

agent_auid

Defina o valor da bagagem AUID do agente.

agent_auid(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A AUID do agente

Retornos

Tipo Description

Auto para encadeamento de métodos

agent_blueprint_id

Defina o valor da bagagem da ID do blueprint do agente.

agent_blueprint_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A ID do blueprint do agente

Retornos

Tipo Description

Auto para encadeamento de métodos

agent_description

Defina o valor da bagagem de descrição do agente.

agent_description(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

agent_id

Defina o valor da bagagem da ID do agente.

agent_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A ID do agente

Retornos

Tipo Description

Auto para encadeamento de métodos

agent_name

Defina o valor da bagagem do nome do agente.

agent_name(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

agent_upn

Defina o valor da bagagem UPN do agente.

agent_upn(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

O UPN do agente

Retornos

Tipo Description

Auto para encadeamento de métodos

build

Aplique a bagagem coletada ao contexto atual.

build() -> BaggageScope

Retornos

Tipo Description

Um gerenciador de contexto que restaura a bagagem anterior na saída

caller_id

Defina o valor da bagagem da ID do chamador.

caller_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A ID do chamador

Retornos

Tipo Description

Auto para encadeamento de métodos

caller_name

Defina o valor da bagagem do nome do chamador.

caller_name(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

caller_upn

Defina o valor da bagagem UPN do chamador.

caller_upn(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

conversation_id

Defina o valor da bagagem da ID da conversa.

conversation_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

Defina o valor da bagagem do link do item de conversa.

conversation_item_link(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

correlation_id

Defina o valor da bagagem da ID de correlação.

correlation_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A ID de correlação

Retornos

Tipo Description

Auto para encadeamento de métodos

from_turn_context

Preencha a bagagem de um turn_context (tipo pato). Delega para baggage_turn_context.from_turn_context.

from_turn_context(turn_context: Any) -> BaggageBuilder

Parâmetros

Nome Description
turn_context
Obrigatório

hiring_manager_id

Defina o valor da bagagem da ID do gerente de contratação.

hiring_manager_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A ID do gerente de contratação

Retornos

Tipo Description

Auto para encadeamento de métodos

operation_source

Defina o valor da bagagem de origem da operação.

operation_source(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

O valor de origem da operação

Retornos

Tipo Description

Auto para encadeamento de métodos

set_pairs

Aceitar ditado ou iterável de (k,v).

set_pairs(pairs: Any) -> BaggageBuilder

Parâmetros

Nome Description
pairs
Obrigatório

set_request_context

Método de conveniência para iniciar um escopo de bagagem de solicitação com campos comuns.

static set_request_context(tenant_id: str | None = None, agent_id: str | None = None, correlation_id: str | None = None) -> BaggageScope

Parâmetros

Nome Description
tenant_id

A ID do locatário

Valor padrão: None
agent_id

A ID do agente

Valor padrão: None
correlation_id

A ID de correlação

Valor padrão: None

Retornos

Tipo Description

Um gerenciador de contexto que restaura a bagagem anterior na saída

source_metadata_description

Defina a descrição dos metadados de origem da execução (por exemplo, descrição do canal).

source_metadata_description(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

source_metadata_id

Defina a ID de metadados de origem da execução (por exemplo, ID do canal).

source_metadata_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

source_metadata_name

Defina o nome dos metadados de origem da execução (por exemplo, nome do canal).

source_metadata_name(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

tenant_id

Defina o valor da bagagem da ID do locatário.

tenant_id(value: str | None) -> BaggageBuilder

Parâmetros

Nome Description
value
Obrigatório

A ID do locatário

Retornos

Tipo Description

Auto para encadeamento de métodos