Package intrinsic_proto.skills
Service
BehaviorTreeRegistryInternal
Message
BehaviorTreeDescription
Message
BehaviorTreeRegistration
Message
GetBehaviorTreeRequest
Message
GetBehaviorTreeResponse
Message
ObjectWorldReservation
Message
ProcessedSkillManifest
Message
RegisterOrUpdateBehaviorTreeRequest
Message
RegisterOrUpdateBehaviorTreeResponse
Message
RegisterOrUpdateSkillRequest
Message
ReturnValueDescription
Message
SkillInformationResult
Message
SkillParameterMetadata
Services
service BehaviorTreeRegistry intrinsic/skills/proto/behavior_tree_registry.proto
rpc RegisterOrUpdateBehaviorTree
Request: intrinsic_proto.skills.RegisterOrUpdateBehaviorTreeRequest
Response:
intrinsic_proto.skills.RegisterOrUpdateBehaviorTreeResponse
Register a BehaviorTree skill in the skill registry.
rpc UnregisterBehaviorTree
Request: intrinsic_proto.skills.UnregisterBehaviorTreeRequest
Response:
google.protobuf.Empty
Unregister a BehaviorTree skill from the skill registry.
service BehaviorTreeRegistryInternal intrinsic/skills/internal/proto/behavior_tree_registry_internal.proto
rpc GetBehaviorTree
Request: intrinsic_proto.skills.GetBehaviorTreeRequest
Response:
intrinsic_proto.skills.GetBehaviorTreeResponse
Returns the BehaviorTree that is registered for a specific skill. The requested skill must be a parameterizable BehaviorTree.
service Executor intrinsic/skills/proto/skill_service.proto
rpc StartExecute
Request: intrinsic_proto.skills.ExecuteRequest
Response:
google.longrunning.Operation
Starts executing the skill as a long-running operation.
The RPC fails with: - NOT_FOUND if the skill cannot be found. - INTERNAL if default parameters cannot be applied. - ALREADY_EXISTS if an operation with the derived name already exists.
rpc StartPreview
Request: intrinsic_proto.skills.PreviewRequest
Response:
google.longrunning.Operation
Starts previewing execution of the skill as a long-running operation.
The RPC fails with: - NOT_FOUND if the skill cannot be found. - INTERNAL if default parameters cannot be applied. - ALREADY_EXISTS if an operation with the derived name already exists.
rpc GetOperation
Request: google.longrunning.GetOperationRequest
Response:
google.longrunning.Operation
Gets the current state of a skill operation.
The RPC fails with: - NOT_FOUND if the operation cannot be found.
rpc CancelOperation
Request: google.longrunning.CancelOperationRequest
Response:
google.protobuf.Empty
Requests cancellation of a skill operation.
NOTE: The skill may finish successfully before it can be cancelled. The actual outcome can be inferred from the state returned by a subsequent call to WaitOperation.
The RPC fails with: - NOT_FOUND if the operation cannot be found. - FAILED_PRECONDITION if the operation was already cancelled. - UNIMPLEMENTED if the skill does not support cancellation. - INTERNAL if a skill cancellation callback fails.
rpc WaitOperation
Request: google.longrunning.WaitOperationRequest
Response:
google.longrunning.Operation
Waits for a skill operation to finish.
Unless the wait timed out, the returned state reflects the final outcome of skill execution. NOTE that an unfinished operation will be returned if the wait times out.
If the operation succeeded, the operation's response will be the resulting
ExecuteResult or PreviewResult. Otherwise, the operation's error will
contain information about the failure.
The RPC fails with: - NOT_FOUND if the operation cannot be found.
Clears the internal store of skill operations.
Should only be called once all operations are finished.
The RPC fails with: - FAILED_PRECONDITION if any operations are not finished.
service Projector intrinsic/skills/proto/skill_service.proto
rpc Predict
Request: intrinsic_proto.skills.PredictRequest
Response:
intrinsic_proto.skills.PredictResult
Returns a distribution of possible states that the world could be in after executing the skill with the provided parameters.
rpc GetFootprint
Request: intrinsic_proto.skills.GetFootprintRequest
Response:
intrinsic_proto.skills.GetFootprintResult
Returns the anticipated resources needed, given the nominal initial world.
service SkillInformation intrinsic/skills/proto/skill_service.proto
rpc GetSkillInfo
Request: google.protobuf.Empty
Response:
intrinsic_proto.skills.SkillInformationResult
Returns skill information.
service SkillRegistry intrinsic/skills/proto/skill_registry.proto
Deprecated: Use ListSkills instead. Important: ListSkills is always
paginated. If you require all skills in the registry (behavior of
GetSkills) paginate through all pages.
rpc GetSkill
Request: intrinsic_proto.skills.GetSkillRequest
Response:
intrinsic_proto.skills.GetSkillResponse
Returns information about the requested Skill.
rpc ListSkills
Request: intrinsic_proto.skills.ListSkillsRequest
Response:
intrinsic_proto.skills.ListSkillsResponse
Lists all of the skills currently installed.
service SkillRegistryInternal intrinsic/skills/internal/proto/skill_registry_internal.proto
rpc GetInstance
Request: intrinsic_proto.skills.GetInstanceRequest
Response:
intrinsic_proto.skills.GetInstanceResponse
Returns a skill instance matching the given request.
rpc RemoveSkill
Request: intrinsic_proto.skills.RemoveSkillRequest
Response:
intrinsic_proto.skills.RemoveSkillResponse
Removes a skill from the registry. This method is not required to be implemented by all implementations of the skill registry.
rpc RegisterOrUpdateSkill
Request: intrinsic_proto.skills.RegisterOrUpdateSkillRequest
Response:
google.protobuf.Empty
This is deprecated and currently only works for in-memory implementations (typically used for unit testing). Registers or updates a skill.
Resets the set of instance names.
All skill execution operations must have finished before calling this RPC, since it also calls each unique skill executor service's ClearOperations().
Messages
message BehaviorTreeDescription intrinsic/skills/proto/skills.proto
Message to carry information about a Parameterizable Behavior Tree. Currently used as an indicator, may get additional information later.
| Field | Type | Description |
|---|
message BehaviorTreeRegistration intrinsic/skills/proto/skill_registry_config.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | behavior_tree |
intrinsic_proto.executive.BehaviorTree
|
message CcServiceConfig intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | create_skill |
string
|
The create skill method symbol. This is the fully qualified name of the
method that can be used to create a skill. It must be convertible to a
std::function This method is used at build time to generate the skill service main. For the NoOpSkill example with: namespace intrinsic::skills {
class NoOpSkill {
public:
static std::unique_ptr The Create() method should be registered in the manifest.textproto as: create_skill: "::intrinsic::skills::NoOpSkill::CreateSkill" The generated skill service will create skills by invoking this method. |
message Dependencies intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | required_equipment |
map<string, ResourceSelector>
|
Required interfaces that Services must satisfy for the Skill. |
message ExecuteRequest intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | footprint |
intrinsic_proto.skills.Footprint
|
|
| 3 | internal_data |
bytes
|
Skill-internal data from a previous call to Projector.Predict. |
| 5 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 6 | context |
intrinsic_proto.data_logger.Context
|
Logging context of the operation (e.g. IDs of related plan instance, deployment configs etc.). |
| 7 | world_id |
string
|
ID of the world in the world service which holds the initial world state for the skill execution. |
| 8 | parameters |
google.protobuf.Any
|
message ExecuteResult intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 4 | result |
google.protobuf.Any
|
Contains optional returned data for the Skill. If a Skill returns data in this field, there will also be descriptor information for the type of data in the Skill information retrieved from the registry. |
message ExecutionOptions intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | supports_cancellation |
bool
|
True if the skill supports cooperative cancellation during execution. |
message ExecutionSummary intrinsic/skills/proto/skill_service.proto
Logged by the skills client library after a skill execution.
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 2 | result |
intrinsic_proto.skills.ExecuteResult
|
|
| 3 | duration |
google.protobuf.Duration
|
|
| 4 | trace_id |
string
|
The OpenCensus Trace ID associated with this skill execution. A 32 character hex string. |
| 5 | error_code |
int32
|
Error information if the request failed for any reason. error_code and error_message are not set if extended_status is set. |
| 6 | error_message |
string
|
|
| 7 | error_info |
intrinsic_proto.skills.SkillErrorInfo
|
|
| 8 | extended_status |
intrinsic_proto.status.ExtendedStatus
|
On error, optionally detailed error information. |
message ExtendedDocumentation intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | prerequisites |
string
|
Prerequisites for a skill refer to the necessary conditions and requirements that must be met for the skill to function properly. These can include specific hardware components like sensors or controllers, initial calibration and setup procedures, software dependencies, network configurations, required permissions and access and/or relevant configuration files. |
| 2 | usage_example |
string
|
A usage example of a skill outlines the specific steps and conditions under which the skill is utilized, showcasing its functionality and effectiveness. If the usage example has lengthy details, the author can provide a link to the documentation that shows a practical demonstration of how the skill can be applied in a real-world scenario. |
| 3 | error_handling |
string
|
This field describes the error handling strategy for the skill. It can include information about how to handle specific errors, such as retry strategies or recovery procedures. |
message Footprint intrinsic/skills/proto/footprint.proto
A footprint contains zero or more reservations that must be held when executing a skill. Each reservation has a sharing type which is used to determine when two skills can be scheduled concurrently. Note that volume reservations can also generate conflicts with the geometrical state of the world. E.g., a volume reservation that intersects static geometry would not be schedulable even when the skill is executing by itself.
| Field | Type | Description | |
|---|---|---|---|
| 1 | volume |
repeated
intrinsic_proto.skills.VolumeReservation
|
One or more volume reservations. |
| 3 | lock_the_universe |
bool
|
A special value - true indicates that all entities in the entire universe are held, implying that this holder of this footprint cannot execute at the same time as anything else that holds any entity. NOTE: If set, the volume and entity constraints are ignored and every entity is locked with write access. |
| 4 | object_reservation |
repeated
intrinsic_proto.skills.ObjectWorldReservation
|
One or more reservations in the world (objects or frames). |
| 5 | skip_missing_permissions |
bool
|
By default we will automatically add the extra missing permissions to make this footprint a complete set. This includes read access for all entities in the parent chains of any already specified entities. As well as write access to any children of write enabled entitiees already provided. If set to true, this process will be skipped. |
| 6 | resource_reservation |
repeated
intrinsic_proto.skills.ResourceReservation
|
One or more resource reservations. |
message FootprintSummary intrinsic/skills/proto/skill_service.proto
Logged by the skills client library after a skill get footprint.
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 3 | duration |
google.protobuf.Duration
|
|
| 4 | error_code |
int32
|
Error information if the request failed for any reason. error_code and error_message are not set if extended_status is set. |
| 5 | error_message |
string
|
|
| 6 | error_info |
intrinsic_proto.skills.SkillErrorInfo
|
|
| 7 | get_footprint_result |
intrinsic_proto.skills.GetFootprintResult
|
|
| 8 | extended_status |
intrinsic_proto.status.ExtendedStatus
|
On error, optionally detailed error information. |
message GetBehaviorTreeRequest intrinsic/skills/internal/proto/behavior_tree_registry_internal.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | id |
string
|
The identifier for the skill as in intrinsic_proto.skills.Skill.id. This must refer to a parameterizable behavior tree registered via RegisterOrUpdateBehaviorTree. |
message GetBehaviorTreeResponse intrinsic/skills/internal/proto/behavior_tree_registry_internal.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | behavior_tree |
intrinsic_proto.executive.BehaviorTree
|
message GetFootprintRequest intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | parameters |
google.protobuf.Any
|
|
| 2 | world_id |
string
|
ID of the world in the world service which holds the initial world state for getting the skill footprint. |
| 3 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 4 | context |
intrinsic_proto.data_logger.Context
|
Logging context of the operation (e.g. IDs of related plan instance, deployment configs etc.). |
| 5 | internal_data |
bytes
|
Skill-internal data from a previous call to Predict. |
message GetFootprintResult intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | footprint |
intrinsic_proto.skills.Footprint
|
message GetInstanceRequest intrinsic/skills/internal/proto/skill_registry_internal.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | handles |
map<string, ResourceHandle>
|
The resource the instance will use. |
| 3 | instance_id |
string
|
An optional instance id for the skill. If empty, a unique id will be generated by the registry. |
| 4 | id |
string
|
The skill's id. This can be either the id or the id_version. |
message GetInstanceResponse intrinsic/skills/internal/proto/skill_registry_internal.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | instance |
intrinsic_proto.skills.SkillInstance
|
The returned instance. The contents of this field will only be valid when
|
message GetSkillRequest intrinsic/skills/proto/skill_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | id |
string
|
The identifier for the skill in the form This should be something like ai.intrinsic.hello_world |
message GetSkillResponse intrinsic/skills/proto/skill_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | skill |
intrinsic_proto.skills.Skill
|
Information about the Skill. |
message GetSkillsResponse intrinsic/skills/proto/skill_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | skills |
repeated
intrinsic_proto.skills.Skill
|
The returned skills. The contents of this field will only be valid when
|
message ListSkillsRequest intrinsic/skills/proto/skill_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | page_size |
int32
|
Upper limit for the returned page size, i.e. the service might return fewer results. Default behavior: returns a page size of 20. A page_size of 0 will result in default behavior. Maximum value is 200. If this is exceeded, returns 200. Negative values are invalid and will result in an INVALID_ARGUMENT error. |
| 2 | page_token |
string
|
If the page token is empty, up to |
| 3 | filter |
string
|
A filter expression to filter the returned skills. The format of the filter expression follows the specification outlined in
https://google.aip.dev/160. Only the following field are supported:
* |
message ListSkillsResponse intrinsic/skills/proto/skill_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | skills |
repeated
intrinsic_proto.skills.Skill
|
Skills matching the request. |
| 2 | next_page_token |
string
|
Pass this token to the subsequent list requests in to obtain the next page. |
message ObjectWorldReservation intrinsic/skills/proto/footprint.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | type |
intrinsic_proto.skills.ObjectWorldReservation.SharingType
|
The type of reservation lock. |
|
oneof object_type
|
|||
| 2 | object |
intrinsic_proto.world.ObjectReferenceByName
|
Name of an object. |
| 3 | frame |
intrinsic_proto.world.FrameReferenceByName
|
Name of a frame and its parent object. |
message Options intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | supports_cancellation |
bool
|
Indicates whether the skill supports cooperative cancellation during execution. True if the skill supports cancellation, false otherwise. |
| 2 | cancellation_ready_timeout |
google.protobuf.Duration
|
Sets the cancellation ready time for the skill during execution. During execution, if the skill is cancelled, its ExecuteContext waits for at most this timeout duration for the skill to have called Ready() (C++) or ready() (Python) before raising a timeout error. If this timeout is not specified, then the default used by the skill service is 30 seconds. |
| 3 | execution_timeout |
google.protobuf.Duration
|
Sets the execution timeout for the skill. If this timeout is not specified, then the default used by the skill service is 180 seconds. |
|
oneof language_specific_options
|
|||
| 10 | python_config |
intrinsic_proto.skills.PythonServiceConfig
|
|
| 11 | cc_config |
intrinsic_proto.skills.CcServiceConfig
|
|
message ParameterDescription intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | default_value |
google.protobuf.Any
|
Specifies the default values used by the Skill |
| 2 | parameter_descriptor_fileset |
google.protobuf.FileDescriptorSet
|
The set of FileDescriptors needed to dynamically create a message from a factory |
| 4 | parameter_message_full_name |
string
|
|
| 5 | parameter_field_comments |
map<string, string>
|
New users of the Skill APIs should prefer to retrieve comments from the
The leading comments of the fields in the parameter message. The key is the full name of the field. |
message ParameterMetadata intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | message_full_name |
string
|
The fully-qualified name of the Protobuf message |
| 2 | default_value |
optional
google.protobuf.Any
|
The default value used by the skill for this |
message PredictRequest intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | parameters |
google.protobuf.Any
|
|
| 3 | world_id |
string
|
ID of the world in the world service which holds the initial world state for the prediction. |
| 4 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 5 | context |
intrinsic_proto.data_logger.Context
|
Logging context of the operation (e.g. IDs of related plan instance, deployment configs etc.). |
| 6 | internal_data |
bytes
|
Optional skill-internal data from a previous call to Predict. |
message PredictResult intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | outcomes |
repeated
intrinsic_proto.skills.Prediction
|
The possible set of outcomes given the skill and its parameters. This list
of outcomes should represent a probability distribution (i.e. the
|
| 3 | internal_data |
bytes
|
Skill-internal data to pass to Projector.GetFootprint and Executor.StartExecute. |
message Prediction intrinsic/skills/proto/prediction.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | probability |
double
|
Probability that this prediction will happen. |
| 2 | result |
google.protobuf.Any
|
The expected return values from the skill. Has the same caveats as the result in intrinsic_proto.skills.ExecuteResult. |
| 3 | expected_states |
repeated
intrinsic_proto.skills.TimedWorldUpdate
|
The expected world states during the execution of the skill. Updates are ordered such that each subsequent update should be applied to the previous one after the elapsed number of seconds. The first update should be applied to the initial world used for generating the prediction. |
message PredictionSummary intrinsic/skills/proto/skill_service.proto
Logged by the skills client library after a skill prediction.
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 2 | result |
intrinsic_proto.skills.PredictResult
|
|
| 3 | duration |
google.protobuf.Duration
|
|
| 4 | error_code |
int32
|
Error information if the request failed for any reason. error_code and error_message are not set if extended_status is set. |
| 5 | error_message |
string
|
|
| 6 | error_info |
intrinsic_proto.skills.SkillErrorInfo
|
|
| 7 | extended_status |
intrinsic_proto.status.ExtendedStatus
|
On error, optionally detailed error information. |
message PreviewRequest intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | parameters |
google.protobuf.Any
|
|
| 2 | footprint |
intrinsic_proto.skills.Footprint
|
|
| 3 | internal_data |
bytes
|
Skill-internal data from a previous call to Projector.Predict. |
| 4 | world_id |
string
|
ID of the world in the world service which holds the initial world state for the skill preview. |
| 5 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 6 | context |
intrinsic_proto.data_logger.Context
|
Logging context of the operation (e.g. IDs of related plan instance, deployment configs etc.). |
message PreviewResult intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | result |
google.protobuf.Any
|
The expected return values from the skill. Has the same caveats as the result in intrinsic_proto.skills.ExecuteResult. |
| 2 | expected_states |
repeated
intrinsic_proto.skills.TimedWorldUpdate
|
The expected world states during execution of the skill. Updates are ordered such that each subsequent update should be applied at the specified time and for the specified duration. The first update should be applied to the initial world used for generating the preview. |
message PreviewSummary intrinsic/skills/proto/skill_service.proto
Logged by the skills client library after a skill preview.
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 2 | result |
intrinsic_proto.skills.PreviewResult
|
|
| 3 | duration |
google.protobuf.Duration
|
|
| 4 | trace_id |
string
|
The OpenCensus Trace ID associated with this skill preview. A 32 character hex string. |
| 5 | error_code |
int32
|
Error information if the request failed for any reason. error_code and error_message are not set if extended_status is set. |
| 6 | error_message |
string
|
|
| 7 | error_info |
intrinsic_proto.skills.SkillErrorInfo
|
|
| 8 | extended_status |
intrinsic_proto.status.ExtendedStatus
|
On error, optionally detailed error information. |
message ProcessedSkillAssets intrinsic/skills/proto/processed_skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 3 | file_descriptor_set |
google.protobuf.FileDescriptorSet
|
A complete descriptor set for the skill's parameter and execute_result proto messages. |
|
oneof deployment_type
|
|||
| 1 | image |
intrinsic_proto.workcell_spec.v1.Image
|
A container image for the skill with its service. |
message ProcessedSkillManifest intrinsic/skills/proto/processed_skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | metadata |
intrinsic_proto.skills.SkillMetadata
|
Metadata associated with this skill (e.g., id, documentation, etc.) |
| 2 | details |
intrinsic_proto.skills.SkillDetails
|
Details about how the skill is to be used. |
| 3 | assets |
intrinsic_proto.skills.ProcessedSkillAssets
|
The processed version of the skill assets. This can be used to send a complete description of a skill using a manifest. |
message ProjectRequest intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 3 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 4 | world_id |
string
|
Id of the world in the world service which holds the initial world state for the skill projection. |
| 5 | context |
intrinsic_proto.data_logger.Context
|
OPTIONAL. Context of the projection of the skill instance (e.g. IDs of related plan instance, deployment configs etc.). |
| 6 | parameters |
google.protobuf.Any
|
|
| 7 | internal_data |
bytes
|
OPTIONAL. Skill-internal data about the outcome of planning the skill. This data is optional and if provided can be used to make planning faster. It is intended to be used if the skill was previously planned and needs replanning. |
message ProjectResult intrinsic/skills/proto/skill_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | footprint |
intrinsic_proto.skills.Footprint
|
|
| 5 | internal_data |
bytes
|
Skill-internal data about the outcome of planning the skill. Attempting to execute a skill without passing this data may result in behavior that does not match this ProjectResult. |
message ProjectionSummary intrinsic/skills/proto/skill_service.proto
Logged by the skills client library after a skill projection.
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
intrinsic_proto.skills.SkillInstance
|
|
| 2 | result |
intrinsic_proto.skills.ProjectResult
|
|
| 3 | duration |
google.protobuf.Duration
|
|
| 4 | error_code |
int32
|
Error information if the request failed for any reason. |
| 5 | error_message |
string
|
|
| 6 | error_info |
intrinsic_proto.skills.SkillErrorInfo
|
message PubTopicMetadata intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | data_id |
string
|
Used to construct a unique topic name for publishing. Instances of this
skill will publish to topic /skill/ |
| 2 | description |
string
|
Optional documentation that can be shown to users of the skill. It may include information about the data published on this topic. |
| 3 | message_full_name |
string
|
The published proto's full message name. |
message PythonServiceConfig intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | skill_module |
string
|
The module where the skill's create function is declared. |
| 2 | proto_module |
string
|
The module where the skill's proto message schemas are declared. |
| 3 | create_skill |
string
|
The symbol for the method to create the skill. This is commonly the skill's constructor. For example, for a skill declared in: intrinsic/skills/examples/my_skill.py class MySkill(skl.Skill): def init(self): pass this field should be set to: "intrinsic.skills.examples.my_skill.MySkill" to use the class's constructor to create the skill. |
message RegisterOrUpdateBehaviorTreeRequest intrinsic/skills/proto/behavior_tree_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | registration |
intrinsic_proto.skills.BehaviorTreeRegistration
|
The registration information for the BehaviorTree |
message RegisterOrUpdateBehaviorTreeResponse intrinsic/skills/proto/behavior_tree_registry.proto
| Field | Type | Description |
|---|
message RegisterOrUpdateSkillRequest intrinsic/skills/internal/proto/skill_registry_internal.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | skill_registration |
intrinsic_proto.skills.SkillRegistration
|
The registration information for the skill. |
message RemoveSkillRequest intrinsic/skills/internal/proto/skill_registry_internal.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | id |
string
|
The id of the skill to remove. |
message RemoveSkillResponse intrinsic/skills/internal/proto/skill_registry_internal.proto
| Field | Type | Description |
|---|
message ResourceReservation intrinsic/skills/proto/footprint.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | type |
intrinsic_proto.skills.ResourceReservation.SharingType
|
The type of reservation. |
| 2 | name |
string
|
Name of the equipment to be locked. |
message ResourceSelector intrinsic/skills/proto/equipment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | capability_names |
repeated
string
|
The selector only matches Services that provide all of the gRPC services specified here. Each capability name must be the fully qualified name of a gRPC service. |
| 2 | sharing_type |
intrinsic_proto.skills.ResourceReservation.SharingType
|
Specifies how the Service will be used. NOTE that the sharing type is not enforced. It only specifies the Skill's intent. |
message ReturnMetadata intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | message_full_name |
string
|
The fully-qualified name of the Protobuf message |
message ReturnValueDescription intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | descriptor_fileset |
google.protobuf.FileDescriptorSet
|
The set of FileDescriptors needed to dynamically create a message from a factory. More precisely, this is the smallest set containing the file descriptor, A, with the message definition for the return value, along with the file descriptors for all transitive dependencies of file descriptor A. |
| 4 | return_value_message_full_name |
string
|
|
| 5 | return_value_field_comments |
map<string, string>
|
New users of the Skill APIs should prefer to retrieve comments from the
The leading comments of the fields in the return value message. The key is the full name of the field. |
message Skill intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | skill_name |
string
|
A well-known name for this skill. |
| 4 | resource_selectors |
map<string, ResourceSelector>
|
Maps resource slot name to a selector describing handles that can satisfy the implementation's requirements for that slot. |
| 5 | description |
string
|
Description of the skill. |
| 6 | parameter_description |
intrinsic_proto.skills.ParameterDescription
|
Description information for the parameters of this Skill. |
| 7 | return_value_description |
intrinsic_proto.skills.ReturnValueDescription
|
Description information for the data returned by a Skill's Execution. This is only present if a Skill utilizes return values. |
| 9 | package_name |
string
|
The package name for the skill. This is dot-separated string describing the package for the skill. |
| 10 | id |
string
|
The skill id, formatted as: |
| 11 | id_version |
string
|
The fully-qualified globally unique id of the skill, formatted as:
|
| 12 | behavior_tree_description |
optional
intrinsic_proto.skills.BehaviorTreeDescription
|
Parameterizable Behavior Tree Description, if set, the executive can retrieve a tree for this skill's ID. |
| 13 | execution_options |
intrinsic_proto.skills.ExecutionOptions
|
Information about options supported by this skill during execution. |
| 14 | display_name |
string
|
Display name of the skill. |
| 15 | sideloaded |
bool
|
Whether the skill is sideloaded into the solution. |
message SkillAssets intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 3 | file_descriptor_set_filename |
optional
string
|
A complete descriptor set for the skill's parameter and execute_result proto messages. |
|
oneof deployment_type
|
|||
| 1 | image_filename |
string
|
The filename of the skill image. |
message SkillDetails intrinsic/skills/proto/processed_skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | options |
intrinsic_proto.skills.Options
|
Contains user-set options about what skill features are supported by this skill. |
| 2 | dependencies |
intrinsic_proto.skills.Dependencies
|
Specifies the runtime dependencies of this skill. |
| 3 | parameter |
intrinsic_proto.skills.ParameterMetadata
|
A description of the input parameter message for the skill. |
| 4 | execute_result |
optional
intrinsic_proto.skills.ReturnMetadata
|
A description of the execute result for a skill invocation. |
| 7 | status_info |
repeated
intrinsic_proto.assets.StatusSpec
|
List of status codes which the specific skill may return. Codes are
specific to the skill's ID ( |
message SkillErrorInfo intrinsic/skills/proto/error.proto
This message describes more detailed information about an error during interacting with a skill. It is returned as a payload in the status of Project and Execute.
| Field | Type | Description | |
|---|---|---|---|
| 1 | error_type |
intrinsic_proto.skills.SkillErrorInfo.ErrorType
|
message SkillInformationResult intrinsic/skills/proto/skill_service.proto
Contains the skill information provided by a single skill service.
| Field | Type | Description | |
|---|---|---|---|
| 2 | skill |
intrinsic_proto.skills.Skill
|
message SkillInstance intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance_name |
string
|
The globally-unique name of this skill instance. |
| 4 | project_handle |
intrinsic_proto.skills.SkillHandle
|
Dispatcher handle to project this skill. |
| 5 | execute_handle |
intrinsic_proto.skills.SkillHandle
|
Dispatcher handle to execute this skill. |
| 6 | resource_handles |
map<string, ResourceHandle>
|
Maps resource slot name to a handle satisfying the slot's selector. This map must contain an entry for each slot in the implementation's resource_selectors map. |
| 10 | id_version |
string
|
The fully-qualified globally unique id of the skill, formatted as:
|
message SkillManifest intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | id |
intrinsic_proto.assets.Id
|
The skill's id. |
| 2 | vendor |
intrinsic_proto.assets.Vendor
|
The skill's vendor. |
| 3 | documentation |
intrinsic_proto.assets.Documentation
|
Documentation about the skill which will be shown to users. This field should contain the description of the skill as a summary. |
| 4 | options |
intrinsic_proto.skills.Options
|
Contains user-set options about what skill features are supported by this skill. |
| 5 | dependencies |
intrinsic_proto.skills.Dependencies
|
Specifies the runtime dependencies of this skill. |
| 6 | parameter |
intrinsic_proto.skills.ParameterMetadata
|
A description of the input parameter message for Execution of the skill. |
| 7 | return_type |
optional
intrinsic_proto.skills.ReturnMetadata
|
A description of the return type for Execution of the skill. |
| 9 | display_name |
string
|
The display name of the skill to be shown in the UI. |
| 10 | extended_documentation |
optional
intrinsic_proto.skills.ExtendedDocumentation
|
Extended documentation about the skill which will be shown to users. This field contains additional information about the skill that is used by automatic skill documentation generation tools. It is optional and can be left empty. However, only skills that specify this field will be included in automatic skill documentation generation. |
| 11 | status_info |
repeated
intrinsic_proto.assets.StatusSpec
|
List of status codes which the specific skill may return. Codes are
specific to the skill's ID ( |
| 12 | assets |
intrinsic_proto.skills.SkillAssets
|
This skill's assets. |
message SkillManifests intrinsic/skills/proto/skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | manifests |
repeated
intrinsic_proto.skills.SkillManifest
|
message SkillMetadata intrinsic/skills/proto/processed_skill_manifest.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | id |
intrinsic_proto.assets.Id
|
The skill's id. |
| 2 | vendor |
intrinsic_proto.assets.Vendor
|
The skill's vendor. |
| 3 | documentation |
intrinsic_proto.assets.Documentation
|
Documentation about the skill which will be shown to users. This field should contain the description of the skill as a summary. |
| 5 | display_name |
string
|
The display name of the skill to be shown in the UI. |
message SkillParameterMetadata intrinsic/skills/proto/skill_parameter_metadata.proto
Metadata that further describes a field in a skill's parameter proto. This metadata can be added using a proto option. Parameter metadata is optional and may be omitted in parts or entirely.
Example:
message MySkill {
string distance_to_edge_m = 1
[(intrinsic_proto.skills.skill_parameter_metadata).unit = "m"];
}
Tools (e.g., the frontend) may use the information provided in field metadata to show additional guidance or expose targeted functionality during parameterization.
DEPRECATED: Use intrinsic_proto.assets.field_metadata instead.
| Field | Type | Description | |
|---|---|---|---|
| 1 | unit |
string
|
Unit of the parameter. This should be the symbol for the unit rather than the full name (e.g., "m" for meters or "rad" for radian). If empty, the parameter is treated as unitless. When possible, field names should contain their unit as a suffix. This ensures that people working with generated code for the parameter proto always have access to unit information. |
| 2 | is_icon2_position_part |
bool
|
Designator for a field that holds an Icon2PositionPart reference. This can be used to designate a particular field in the UI that should be used to select a part name. |
message SkillRegistration intrinsic/skills/proto/skill_registry_config.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | validate_handle |
intrinsic_proto.skills.SkillHandle
|
|
| 2 | project_handle |
intrinsic_proto.skills.SkillHandle
|
|
| 3 | execute_handle |
intrinsic_proto.skills.SkillHandle
|
|
| 4 | skill |
intrinsic_proto.skills.Skill
|
|
| 5 | skill_info_handle |
intrinsic_proto.skills.SkillHandle
|
message SkillRegistryConfig intrinsic/skills/proto/skill_registry_config.proto
| Field | Type | Description | |
|---|---|---|---|
| 2 | skills |
repeated
intrinsic_proto.skills.SkillRegistration
|
|
| 3 | behavior_trees |
repeated
intrinsic_proto.skills.BehaviorTreeRegistration
|
message StringVector intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | values |
repeated
string
|
message TimedWorldUpdate intrinsic/skills/proto/prediction.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | time_until_update |
google.protobuf.Duration
|
The expected duration of the update. |
| 2 | world_updates |
intrinsic_proto.world.ObjectWorldUpdates
|
World updates to apply. |
| 3 | start_time |
google.protobuf.Timestamp
|
Time at which the update is expected to start. If omitted, the update is assumed to start immediately at the end of the previous update, or at the beginning of skill execution if there is no previous update. |
message UnregisterBehaviorTreeRequest intrinsic/skills/proto/behavior_tree_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | id |
string
|
The id of the behavior tree's skill representation to remove. |
message VectorNdArray intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | array |
repeated
intrinsic_proto.skills.VectorNdValue
|
message VectorNdValue intrinsic/skills/proto/skills.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | value |
repeated
double
|
message VolumeReservation intrinsic/skills/proto/footprint.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | type |
intrinsic_proto.skills.VolumeReservation.SharingType
|
The type of volume lock. |
|
oneof volume_oneof
|
|||
| 4 | shape |
intrinsic_proto.geometry.TransformedGeometryStorageRefs
|
|
Enums
enum ErrorType intrinsic/skills/proto/error.proto
| Name | Number | Description |
|---|---|---|
ERROR_TYPE_UNKNOWN |
0 | |
ERROR_TYPE_GRPC |
1 | |
ERROR_TYPE_SKILL |
2 |
enum SharingType intrinsic/skills/proto/footprint.proto
| Name | Number | Description |
|---|---|---|
WRITE |
0 | The holder has an exclusive lock on this object and is free to change its state. For example, a writer lock must be held to control a robot. |
READ |
1 | The holder has a shared lock on this object and its state must not change until all reader locks are released. |
enum SharingType intrinsic/skills/proto/footprint.proto
| Name | Number | Description |
|---|---|---|
WRITE |
0 | The holder is allowed to change the contents of the volume. This is an exclusive lock. For example, a robot moving through a swept volume would need to acquire this type of lock. |
enum SharingType intrinsic/skills/proto/footprint.proto
| Name | Number | Description |
|---|---|---|
UNSPECIFIED |
0 | Unspecified sharing type is treated the same as WRITE_NONEXCLUSIVE. |
WRITE |
1 | The holder requires exclusive access to read and change the state of this resource. |
READ |
2 | The holder can read but may not change the state of this resource. |
WRITE_EXCLUSIVE_READ_NONEXCLUSIVE |
3 | The holder can read and change the state of this resource. It requires exclusive access to change the state, but does not require exclusive access to read it. |
WRITE_NONEXCLUSIVE |
4 | The holder can read and change the state of this resource, but does not require exclusive access to either. |