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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_ASSISTANT_MODEL_ASSISTANT_QUERY_H_
#define ASH_ASSISTANT_MODEL_ASSISTANT_QUERY_H_
#include <string>
#include "base/component_export.h"
#include "chromeos/ash/services/assistant/public/cpp/assistant_service.h"
namespace ash {
// AssistantQueryType ----------------------------------------------------------
// Defines possible types of an Assistant query.
enum class AssistantQueryType {
kNull, // See AssistantNullQuery.
kText, // See AssistantTextQuery.
kVoice, // See AssistantVoiceQuery.
};
// AssistantQuery --------------------------------------------------------------
// Base class for an Assistant query.
class COMPONENT_EXPORT(ASSISTANT_MODEL) AssistantQuery {
public:
using AssistantQuerySource = assistant::AssistantQuerySource;
AssistantQuery(const AssistantQuery&) = delete;
AssistantQuery& operator=(const AssistantQuery&) = delete;
virtual ~AssistantQuery() = default;
// Returns the type for the query.
AssistantQueryType type() const { return type_; }
// Returns the input source for the query.
AssistantQuerySource source() const { return source_; }
// Returns true if the query is empty, false otherwise.
virtual bool Empty() const = 0;
protected:
AssistantQuery(AssistantQueryType type, AssistantQuerySource source)
: type_(type), source_(source) {}
private:
const AssistantQueryType type_;
const AssistantQuerySource source_;
};
// AssistantNullQuery ----------------------------------------------------------
// An null Assistant query used to signify the absence of an Assistant query.
class COMPONENT_EXPORT(ASSISTANT_MODEL) AssistantNullQuery
: public AssistantQuery {
public:
AssistantNullQuery()
: AssistantQuery(AssistantQueryType::kNull,
AssistantQuerySource::kUnspecified) {}
AssistantNullQuery(const AssistantNullQuery&) = delete;
AssistantNullQuery& operator=(const AssistantNullQuery&) = delete;
~AssistantNullQuery() override = default;
// AssistantQuery:
bool Empty() const override;
};
// AssistantTextQuery ----------------------------------------------------------
// An Assistant text query.
class COMPONENT_EXPORT(ASSISTANT_MODEL) AssistantTextQuery
: public AssistantQuery {
public:
AssistantTextQuery(const std::string& text, AssistantQuerySource source)
: AssistantQuery(AssistantQueryType::kText, source), text_(text) {}
AssistantTextQuery(const AssistantTextQuery&) = delete;
AssistantTextQuery& operator=(const AssistantTextQuery&) = delete;
~AssistantTextQuery() override = default;
// AssistantQuery:
bool Empty() const override;
// Returns the text for the query.
const std::string& text() const { return text_; }
private:
const std::string text_;
};
// AssistantVoiceQuery ---------------------------------------------------------
// An Assistant voice query. At the start of a voice query, both the high and
// low confidence speech portions will be empty. As speech recognition
// continues, the low confidence portion will become non-empty. As speech
// recognition improves, both the high and low confidence portions of the query
// will be non-empty. When speech is fully recognized, only the high confidence
// portion will be populated.
class COMPONENT_EXPORT(ASSISTANT_MODEL) AssistantVoiceQuery
: public AssistantQuery {
public:
AssistantVoiceQuery() : AssistantVoiceQuery(std::string(), std::string()) {}
AssistantVoiceQuery(const std::string& high_confidence_speech,
const std::string& low_confidence_speech = std::string())
: AssistantQuery(AssistantQueryType::kVoice,
AssistantQuerySource::kVoiceInput),
high_confidence_speech_(high_confidence_speech),
low_confidence_speech_(low_confidence_speech) {}
AssistantVoiceQuery(const AssistantVoiceQuery&) = delete;
AssistantVoiceQuery& operator=(const AssistantVoiceQuery&) = delete;
~AssistantVoiceQuery() override = default;
// AssistantQuery:
bool Empty() const override;
// Returns speech for which we have high confidence of recognition.
const std::string& high_confidence_speech() const {
return high_confidence_speech_;
}
// Returns speech for which we have low confidence of recognition.
const std::string& low_confidence_speech() const {
return low_confidence_speech_;
}
private:
const std::string high_confidence_speech_;
const std::string low_confidence_speech_;
};
} // namespace ash
#endif // ASH_ASSISTANT_MODEL_ASSISTANT_QUERY_H_
|