File: web_contents_passage_embedder.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (104 lines) | stat: -rw-r--r-- 3,746 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_PASSAGE_EMBEDDINGS_WEB_CONTENTS_PASSAGE_EMBEDDER_H_
#define CHROME_BROWSER_PASSAGE_EMBEDDINGS_WEB_CONTENTS_PASSAGE_EMBEDDER_H_

#include <optional>
#include <string>
#include <vector>

#include "base/memory/raw_ref.h"
#include "base/memory/weak_ptr.h"
#include "components/passage_embeddings/passage_embeddings_types.h"
#include "content/public/browser/visibility.h"
#include "content/public/browser/web_contents_observer.h"

namespace content {
class WebContents;
}

namespace passage_embeddings {

// Base class for objects that compute embeddings for WebContents passages.
class WebContentsPassageEmbedder : public content::WebContentsObserver {
 public:
  class Delegate {
   public:
    virtual ~Delegate() {}
    virtual Embedder::TaskId ComputePassagesEmbeddings(
        std::vector<std::string> passages,
        Embedder::ComputePassagesEmbeddingsCallback callback) = 0;
    virtual bool TryCancel(Embedder::TaskId task_id) = 0;
    virtual void OnWebContentsDestroyed(content::WebContents* web_contents) = 0;
  };

  WebContentsPassageEmbedder(content::WebContents* web_contents,
                             Delegate& delegate);
  ~WebContentsPassageEmbedder() override;

  // content::WebContentsObserver:
  void WebContentsDestroyed() override;

  // Process passages for potential embeddings computation.
  virtual void AcceptPassages(std::vector<std::string> passages) = 0;

  // Provides an opportunity for subclasses to process passages when the overall
  // priority increases.
  virtual void MaybeProcessPendingPassagesOnPriorityIncrease() {}

  std::optional<Embedder::TaskId> current_task_id() const {
    return current_task_id_;
  }

 protected:
  // Request embeddings to be computed for `passages`.
  void ComputeEmbeddings(std::vector<std::string> passages);

  // Receive computed embeddings.
  void OnPassageEmbeddingsComputed(std::vector<std::string> passages,
                                   std::vector<Embedding> embeddings,
                                   Embedder::TaskId task_id,
                                   ComputeEmbeddingsStatus status);

 private:
  raw_ref<Delegate> delegate_;
  std::optional<Embedder::TaskId> current_task_id_;
  base::WeakPtrFactory<WebContentsPassageEmbedder> weak_ptr_factory_{this};
};

// A WebContentsPassageEmbedder that computes embeddings immediately on passage
// receipt.
class WebContentsImmediatePassageEmbedder : public WebContentsPassageEmbedder {
 public:
  WebContentsImmediatePassageEmbedder(content::WebContents* web_contents,
                                      Delegate& delegate);

  // WebContentsPassageEmbedder:
  void AcceptPassages(std::vector<std::string> passages) override;
};

// A WebContentsPassageEmbedder that computes embeddings only on WebContents
// backgrounding.
class WebContentsBackgroundPassageEmbedder : public WebContentsPassageEmbedder {
 public:
  WebContentsBackgroundPassageEmbedder(content::WebContents* web_contents,
                                       Delegate& delegate);
  ~WebContentsBackgroundPassageEmbedder() override;

  // content::WebContentsObserver:
  void OnVisibilityChanged(content::Visibility visibility) override;

  // WebContentsPassageEmbedder:
  void AcceptPassages(std::vector<std::string> passages) override;
  void MaybeProcessPendingPassagesOnPriorityIncrease() override;

 private:
  std::vector<std::string> pending_passages_;
  content::Visibility web_contents_visibility_ = content::Visibility::HIDDEN;
};

}  // namespace passage_embeddings

#endif  // CHROME_BROWSER_PASSAGE_EMBEDDINGS_WEB_CONTENTS_PASSAGE_EMBEDDER_H_