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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_HISTORY_EMBEDDINGS_ANSWERER_H_
#define COMPONENTS_HISTORY_EMBEDDINGS_ANSWERER_H_
#include <string>
#include <unordered_map>
#include <vector>
#include "base/functional/callback.h"
#include "components/optimization_guide/core/model_quality/model_quality_log_entry.h"
#include "components/optimization_guide/proto/features/history_answer.pb.h"
namespace history_embeddings {
// The status of an answer generation attempt.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class ComputeAnswerStatus {
// Not yet specified. This status in an AnswererResult means the answer
// isn't ready yet.
kUnspecified = 0,
// Answer generation is being attempted.
kLoading = 1,
// Answer generated successfully.
kSuccess = 2,
// Question is not answerable.
kUnanswerable = 3,
// The model files required for generation are not available.
kModelUnavailable = 4,
// Failure occurred during model execution.
kExecutionFailure = 5,
// Model execution cancelled.
kExecutionCancelled = 6,
// Model response is filtered.
kFiltered = 7,
// These values are logged with histograms; append only, above
// this line, and update `kMaxValue` to the last value.
kMaxValue = kFiltered
};
// Holds an answer from the model and associations to source context.
struct AnswererResult {
AnswererResult();
AnswererResult(
ComputeAnswerStatus status,
std::string query,
optimization_guide::proto::Answer answer,
std::unique_ptr<optimization_guide::ModelQualityLogEntry> log_entry,
std::string url,
std::vector<std::string> text_directives);
AnswererResult(ComputeAnswerStatus status,
std::string query,
optimization_guide::proto::Answer answer);
AnswererResult(AnswererResult&&);
~AnswererResult();
AnswererResult& operator=(AnswererResult&&);
// Utility method to add scroll to text fragment directive to result.
// The `passages` are the relevant portion of context for answer URL.
void PopulateScrollToTextFragment(const std::vector<std::string>& passages);
ComputeAnswerStatus status = ComputeAnswerStatus::kUnspecified;
std::string query;
optimization_guide::proto::Answer answer;
// The partially populated v2 quality log entry. This will be dropped
// on destruction to avoid logging when logging is disabled. If logging
// is enabled, then it will be taken from here by
// HistoryEmbeddingsService::SendQualityLog and then logged via destruction.
std::unique_ptr<optimization_guide::ModelQualityLogEntry> log_entry;
// URL source of the answer.
std::string url;
// Scroll-to-text directives constructed from cited passages.
// See https://wicg.github.io/scroll-to-text-fragment/#syntax.
// Format: `#:~:text=start_text,end_text`.
// There is one text directive for each cited passage.
std::vector<std::string> text_directives;
};
using ComputeAnswerCallback = base::OnceCallback<void(AnswererResult result)>;
// Base class that hides implementation details for how answers are generated.
class Answerer {
public:
// This type specifies the query context that can be used to inform
// generated answers. It includes top search result passages and
// potentially other data.
struct Context {
explicit Context(std::string session_id);
Context(const Context&);
Context(Context&&);
~Context();
// Session ID to relate v2 logging with v1 logging session.
std::string session_id;
// URL to passages.
std::unordered_map<std::string, std::vector<std::string>> url_passages_map;
};
virtual ~Answerer() = default;
// Returns 0 if not ready, and the nonzero model version number when it's
// loaded and ready.
virtual int64_t GetModelVersion() = 0;
// Calls `callback` asynchronously with answer to `query`.
virtual void ComputeAnswer(std::string query,
Context context,
ComputeAnswerCallback callback) = 0;
};
} // namespace history_embeddings
#endif // COMPONENTS_HISTORY_EMBEDDINGS_ANSWERER_H_
|
