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
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
module continuous_search.mojom;
import "mojo/public/mojom/base/string16.mojom";
import "url/mojom/url.mojom";
// This module contains data structures and an interface to extract search
// results from a Google Search Results Page.
// A single result from the page.
struct SearchResult {
// Link for the result.
url.mojom.Url link;
// Title of the result.
mojo_base.mojom.String16 title;
};
// The types of logically related groups of search results. E.g. organic
// search results, related searches, etc.
enum ResultType {
// Organic search results (regular "10 blue links").
kSearchResults,
// Related searches.
kRelatedSearches
};
// A logically related group of search results with a label. E.g. organic,
// news, etc.
struct ResultGroup {
// The type for this group.
ResultType type;
// A list of results for this group.
array<SearchResult> results;
};
// The result category for the search page. E.g. results, news, images, etc.
enum Category {
// Empty result.
kNone,
// Organic search results (regular "10 blue links").
kOrganic,
};
// All results from a particular category's page.
struct CategoryResults {
// The URL of the document the data was extracted from.
url.mojom.Url document_url;
// The category the associated groups belong to.
Category category_type = kNone;
// Groups of results partitioned by a logical labels.
array<ResultGroup> groups;
};
// Used to extract search results for a Google search page.
interface SearchResultExtractor {
// The outcome of the extraction attempt.
enum Status {
// Extraction was successful.
kSuccess,
// No results were generated from the extraction.
kNoResults,
};
// Performs a structured search of the DOM to extract results of given types
// from the current search result page (with the currently selected category).
// `result_types` is list of result types to extract. The extraction will fail
// and no results will be generated if any of the types cannot be extracted.
ExtractCurrentSearchResults(array<ResultType> result_types)
=> (Status status, CategoryResults results);
};
|
