This glossary covers the main technical concepts discussed in the Design and Developers' Guide.
The following video gives an overview on the various terms used when developing for different voice assistants.
An abstract definition of some operation that might be performed. It
can be a search (such as
FindRestaurants) or perform an operation
BookHotel), and contains action
inputs and one action
output. For more information, see Modeling Actions.
A format for NL training that includes the utterance as well as embedded annotations (or labels). It is used internally by the platform to represent training provided by developers. For more information, see Training and Vocabulary.
When extending a
structure concept, a particular property can be bound to a specific value (for example,
Restaurant can extend a
Business and bind the business category property to be "Restaurant"). For more information, see Relationships Between Concepts.
A dot-delimited set of property names indicating a property or any depth of sub-property of a
structure concept (for example,
country.name on a
review.rating.score on a
restaurant.Restaurant). For more information, see Structure Concepts
Once a capsule is deployed to the Marketplace, it becomes a Bixby service. End-users add and use Bixby services within Bixby.
A unit of contribution in the Marketplace, consisting of a group of related functionality. It also delineates permissions among developers. For more information, see the Overview. Once a capsule has been reviewed, accepted, and deployed to the Marketplace, it becomes a Bixby service.
A period of time when the user is locked into the current capsule before it times out. This ensures that subsequent utterances are always sent to the current capsule for a short amount of time. For more information, see capsule lock.
In many cases in modeling (such as describing action inputs), it is necessary to describe how many values can appear. Cardinality is described in terms of "min cardinality" (
required) and "max cardinality" (
many). For more information, see Cardinality.
"Compile" is used in two senses in Bixby: compiling your capsule's code as a whole, and compiling your capsule's Natural Language model. Compiling your capsule's code happens automatically, but you must explicitly compile your NL model before Bixby can use it to understand utterances. This functionality is available in the Device Simulator, the Story Editor, and the Training Editor.
An abstract definition of a class of possible values. Anything that a user can refer to or that a developer wishes to model can be a concept. Concepts include primitive concepts and structure concepts. For more information, see Modeling Concepts.
A data value that is an instance of a concept.
See library models.
A point in time, consisting of a date and a time. Dates and times can also be used in isolation. For more information, see DateTime (
A person or organization that can make modifications to capsules.
A dialog response triggered before, during, or after execution. Examples include progress notification, action confirmation, prompts for more information, error messages, and result messages. For more information, see Dialog Events.
A composable template for dialog, relevant to a particular mode. The modes are
Value. For more information, see Dialog Fragments.
An operation that changes the plan in response to conditions encountered during execution. Effects include replacing or dropping an input, prompting a user for new input, or halting plan execution. For more information, see Effects.
A structure concept that has a fixed set of values. (For example, the
viv.measurement.LengthUnit concept might have values
Millimeter, etc.) For more information, see the
enum reference page.
A simple language for expressions used in a few places such as dialogs, strategies and layouts. For more information, see Using Expression Language.
The resulting directed graph that outlines the plan Bixby used during execution. For more information, see The Execution Graph.
A relationship between two concepts, where a child concept can extend a parent concept by adding additional properties. Represents a single-directional is-a relationship (for example, a restaurant is a business). For more information, see Extension.
An addition to a conversation from Bixby after giving an initial result. For more information, see Guiding Conversations.
See goal signal.
A signal in a plan intent indicating the result type of the plan. For more information, see the
goal reference page.
User-mode of Bixby that is activated when users say the wake phrase "Hi Bixby". Normally, this implies that users cannot see and/or touch the device to interact with it. If Bixby is presenting options in a selection or reading out results from a list, then the user is using hands-free list navigation while in hands-free mode. Additionally, the
$handsFree expression variable returns
true in this mode. Bixby-enabled watch devices can only be put in hands-free mode when they are paired with Bluetooth headphones.
User-mode of Bixby that is activated when users press and hold the Bixby button on the device or taps the Bixby button on the device's screen when Bixby is already opened. This implies that the user can see and/or touch the screen, as well as use the Bixby button to answer. Additionally, the
$handsFree expression variable returns
false in this mode.
A strategy that suggests default values for a concept for an instantiation prompt. For more information, see Default Values.
A description of the way content or forms are presented to the user within a larger views file. For more information, see layouts.
Capsules that you can import into your capsule that provide essential models and actions, such as geography and time. For more information, see Library Capsules.
Certain essential capsules that are provided by the platform through library capsules, including support for geographic models and data, date and time, payments, and credentials. Also known as code models.
A specific location defined by an ISO 3166 code, made up of a two letter language code and an option two letter country code. For example,
en-US is the US English locale,
en-GB is the Great Britain English locale,
en is the English locale that covers all english-speaking countries, and
ko-KR is the South Korean Korean locale. The
base subfolder in your
resources directory covers all targeted locales. For more information, see Organizing Your Capsule Resources.
A pattern that matches against a subset of the plan graph. It is expressed as a labeled sub-graph of the plan graph, written as a tree where the root is the current point of execution.
The Marketplace is the multi-device, multi-locale location, where all your capsule submissions can be published to all the Bixby targets defined in your
capsule.bxb file. For more information, see Working With the Marketplace.
The response from Bixby within a conversation that is made up of dialog, views, and follow-ups. There are three types of Moments: input moment, confirmation moment, and result moment. For more information, see Moments.
Examples contributed by developers to that teach the platform's machine learning system how to map utterances to intents. Internally, NL training is represented as aligned text, though more commonly it is edited through the training editor.
Anything a human might type or say when interacting with Bixby. It need not be grammatical, and can be of any language.
A unique identifier for a node. The node ID of a concept or action is typically of the form
restaurant.FindRestaurants (where, in the first example,
air is a capsule name, and
Flight is a name for the concept, and similarly for the action). Other nodes might have internal or generated IDs that reflect their function in a graph.
When extending a concept, it is possible to override a property with modifications. For example a
Restaurant concept can override a
name property to be a
RestaurantName. For more information, see the
override reference page.
An entity that has ownership of concept values, including both capsules and users.
The ability to access to a specific piece of sensitive data, such as a credit card number or password. For more information, see Granting Capsule Permissions.
The core software of Bixby, excluding contributions from developers, including systems that support interpretation, planning, and execution, as well as library models.
A set of steps (technically, a graph) that might be executed to yield a goal. A plan can include a goal, route, reference, or subplan. For more information, see Customizing the Plan.
The graph that describes a plan, consisting of nodes corresponding to nodes and edges indicating relationships, such as inputs, outputs, projections, and other operations.
One of the primitive data types, such as numbers or string names. For more information, see Primitive Concepts.
An interruption in execution to confirm with the user, or to elicit a value or selection. For more information, see Prompting Users.
A field within a structure concept. Represents a "has-a" relationship between the structure concept and the property's concept. For more information, see Properties.
An entity or organization that provides data or services to the platform. For example one provider might be a weather data feed; another might be a restaurant booking API.
A type of intermediary goal for which a prompt is prompting. When Bixby fails to reach the original goal and has to prompt the user, that response is used to reach the recovery goal, which in turn helps Bixby complete the original goal. For more information, see Prompting Users.
An inquiry by the user to Bixby. For more information, see Requests.
A prompt that asks the user to make a selection. For more information, see Selection Prompts.
See web service.
When an action changes things in the world, such as modifying things remote service, or performing an action in the "real world," we say it has side effects. For more information, see Transactional Workflows.
A signal that indicates a recursive subplan. For more information, see the
subplan reference page.
A device and locale collection of capsules. For example,
bixby-mobile-ko-KR is the target for all capsules for mobile devices in Korean. For more information, see Set Device and Locale Targets.
Referring to the sum total of all NL contributions for a capsule. For example, you could say “The training for the Uber capsule is in great shape”. But you shouldn't say “The trainings for the Uber capsule are in great shape”. See also NL Training. For more information, see Introduction for Training for Natural Language.
An individual unit of training for a capsule. A set of those units would then be referred to as training examples (not "trainings"). See Training for Natural Language.
An end-user of the entire system.
A natural language request made actually or potentially made by user.
See concept value.
Renders and displays the content of a Moment. For more information, see Building Bixby Views (UI).
Words or phrases contributed to a particular node, to allow NL intent interpretation to recognize when that node is referred to. For more information, see Extending Training with Vocabulary.