localvectordb.visualization.interactive module

Interactive plotly-based plots (optional dependency).

localvectordb.visualization._interactive.plot_embedding_map_interactive(projection: EmbeddingProjection, color_by: List[str] | None = None, hover_data: List[str] | None = None, queries: List[QueryOverlay] | None = None, title: str = 'Document Embedding Map', **kwargs) → Figure

Interactive scatter plot of projected embeddings using plotly.

Parameters:

  • projection (EmbeddingProjection) – Dimensionality-reduced coordinates.

  • color_by (list of str, optional) – Category labels for each point.

  • hover_data (list of str, optional) – Additional hover text per point.

  • queries (list of QueryOverlay, optional) – Query overlays.

  • title (str) – Plot title.

Return type:

plotly.graph_objects.Figure

localvectordb.visualization._interactive.plot_similarity_matrix_interactive(sim_matrix: DocumentSimilarityMatrix, title: str = 'Document Similarity Matrix', **kwargs) → Figure

Interactive heatmap of pairwise document similarities.

Parameters:
Return type:

plotly.graph_objects.Figure

localvectordb.visualization._interactive.plot_clusters_interactive(projection: EmbeddingProjection, clusters: ClusterResult, title: str = 'Document Clusters', **kwargs) → Figure

Interactive scatter plot coloured by cluster.

Parameters:
Return type:

plotly.graph_objects.Figure

localvectordb.visualization._interactive.plot_synteny_interactive(chunk_sim: ChunkSimilarityMatrix, similarity_threshold: float = 0.7, orientation: str = 'horizontal', chunk_labels: bool = False, title: str | None = None, **kwargs) → Figure

Interactive synteny ribbon diagram using Plotly SVG shapes.

Parameters:

  • chunk_sim (ChunkSimilarityMatrix) – Full chunk-level similarity matrix.

  • similarity_threshold (float) – Minimum similarity for a ribbon to be drawn.

  • orientation (str) – "horizontal" or "vertical".

  • chunk_labels (bool) – If True, label each chunk segment with its index.

  • title (str, optional) – Plot title.

Return type:

plotly.graph_objects.Figure

localvectordb.visualization._interactive.plot_chord_interactive(chunk_sim: ChunkSimilarityMatrix, similarity_threshold: float = 0.7, min_chunk_distance: int = 3, chunk_labels: bool = False, title: str | None = None, **kwargs) → Figure

Interactive chord (Circos-style) diagram using Plotly.

Parameters:

  • chunk_sim (ChunkSimilarityMatrix) – Chunk self-similarity matrix (doc_id_1 == doc_id_2).

  • similarity_threshold (float) – Minimum similarity for a chord to be drawn.

  • min_chunk_distance (int) – Minimum index distance between chunks.

  • chunk_labels (bool) – If True, label each arc segment.

  • title (str, optional) – Plot title.

Return type:

plotly.graph_objects.Figure