SemanticsApi

Natural-language description of the current design, built by the same semantics engine the plugin uses elsewhere. Read-only, no license.

from ArtisanPlugin.Scripting import SemanticsApi

See also the Python package, ra.semantics.

Methods

Method
DescribeDocument	Returns a human-readable summary of the active document: design type and subtype, finger size, metals, gems and the parametric elements it contains.

DescribeDocument

string SemanticsApi.DescribeDocument()

Returns a human-readable summary of the active document: design type and subtype, finger size, metals, gems and the parametric elements it contains. Empty string when there is no document. Perfect answer material for “what is this design?” questions.

Returns string.