ensure_id() — langchain Function Reference

Architecture documentation for the ensure_id() function in utils.py from the langchain codebase.

Function python Observability TelemetryUtilities

Entity Profile

Observability→ TelemetryUtilities→ ensure_id() — langchain Function Reference

Dependency Diagram

graph TD
  b46a7e1a_7b8e_57da_c2a8_e3fdf5e37789["ensure_id()"]
  b77fd012_b825_e350_c8f5_a8f1b44997d9["utils.py"]
  b46a7e1a_7b8e_57da_c2a8_e3fdf5e37789 -->|defined in| b77fd012_b825_e350_c8f5_a8f1b44997d9
  style b46a7e1a_7b8e_57da_c2a8_e3fdf5e37789 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/utils/utils.py lines 509–521

def ensure_id(id_val: str | None) -> str:
    """Ensure the ID is a valid string, generating a new UUID if not provided.

    Auto-generated UUIDs are prefixed by `'lc_'` to indicate they are
    LangChain-generated IDs.

    Args:
        id_val: Optional string ID value to validate.

    Returns:
        A string ID, either the validated provided value or a newly generated UUID4.
    """
    return id_val or f"{LC_AUTO_PREFIX}{uuid4()}"