Drawing search response objects¶
The following expands server JSON objects rather than the current narrower Go SDK types. Optional omission is distinguished from null and empty arrays.
DrawingSearchResponse¶
Field |
Type |
Description |
|---|---|---|
|
object[] |
Results aggregated by source; [] when empty. |
|
integer |
Number returned, not a pagination total. |
|
string |
exact/semantic. May be omitted for some early empty results. May be omitted when empty. |
|
object |
DrawingSearchResult¶
Field |
Type |
Description |
|---|---|---|
|
string |
Source file identifier for aggregation and provenance. |
|
string |
Business drawing number, separate from drawing_id in exact results. May be omitted when empty. |
|
string |
CAD/drawing identifier, possibly falling back to source ID. Do not substitute it for source_file_id. |
|
number |
Ranking score for this request; not guaranteed equivalent across modes/channels or interpretable as probability. |
|
object |
Best hit, using the hit object below. |
|
object[] or null |
Supporting hits, at most 3 in semantic mode. Exact results may be null; semantic results without supporting hits use []. |
|
string or null |
Source URI. Omitted when source information is not loaded; null when loaded without a URI. |
|
string or null |
Manifest ID. Omitted when source information is not loaded; null when loaded without a manifest. |
|
string |
ready or legacy_unmigrated when the source is loaded. May be omitted when empty. |
|
string[] or null |
Gaps, as described in source objects. Omitted when not loaded; the current implementation may return null when loaded without gaps. |
|
object[] or null |
Complete page list. Omitted when not loaded; the current implementation may return null when loaded without pages. |
|
boolean |
Only true marks the current version in keep_versions results; false is omitted. Omission does not mean the knowledge base has no current version. |
DrawingSearchHit¶
Field |
Type |
Description |
|---|---|---|
|
string |
Retrieved object ID. May be omitted when empty. |
|
string |
Object category. May be omitted when empty. |
|
string |
Retrieval level, such as whole page/region; follow the returned value. May be omitted when empty. |
|
string |
Retrieval channel identifier. May be omitted when empty. |
|
string |
Retrieval scope marker. May be omitted when empty. |
|
string |
Source file identifier for aggregation and provenance. |
|
string |
CAD/drawing identifier, possibly falling back to source ID. Do not substitute it for source_file_id. May be omitted when empty. |
|
string |
Local or object image ID. May be omitted when empty. |
|
string |
Registered page image file ID. May be omitted when empty. |
|
integer |
Associated positive page number. May be omitted when empty. |
|
number[] |
Bounding box coordinates, interpreted with coordinate_space; not necessarily normalized. May be omitted when empty. |
|
number |
Ranking score for this request; not guaranteed equivalent across modes/channels or interpretable as probability. |
|
string |
Hit content. May be omitted when empty. |
|
string |
Hit modality. May be omitted when empty. |
|
string |
Hit reason marker. May be omitted when empty. |
|
string |
Hit channel. May be omitted when empty. |
|
string |
Text evidence ID. May be omitted when empty. |
|
string |
Text kind, such as dimension/technical_requirement. May be omitted when empty. |
|
string |
Normalized evidence text. May be omitted when empty. |
|
string |
Recognition state, determined by returned values; absence does not imply recognized. May be omitted when empty. |
|
string[] |
Recognition-state reason marker. May be omitted when empty. |
|
string |
Coordinate space, such as source_page_px. May be omitted when empty. |
|
object[] |
Pointer object for tracing OCR/VLM sources. May be omitted when empty. |
|
string[] |
Associated structured record identifier. May be omitted when empty. |
|
object |
Extracted dimension observation candidates, not approved engineering facts. May be omitted when empty. |
DrawingSearchSourceRef¶
Field |
Type |
Description |
|---|---|---|
|
string |
Source artifact identifier. May be omitted when empty. |
|
string |
JSON Pointer within the artifact. May be omitted when empty. |
|
string |
Extraction method, such as crop_ocr. May be omitted when empty. |
DrawingSearchDimensionCandidate¶
Field |
Type |
Description |
|---|---|---|
|
string |
Text evidence ID. May be omitted when empty. |
|
string |
Associated region ID. May be omitted when empty. |
|
string |
Property name. May be omitted when empty. |
|
string |
Geometry role marker. May be omitted when empty. |
|
number |
Candidate nominal value. Omitted when unset; 0 is also valid. |
|
string |
Original tolerance text. May be omitted when empty. |
|
number |
Candidate lower bound. Omitted when unset; 0 is also valid. |
|
number |
Candidate upper bound. Omitted when unset; 0 is also valid. |
|
string |
Candidate unit. May be omitted when empty. |
|
string |
Original dimension text. May be omitted when empty. |
|
string |
Extraction authority/candidate marker; still verify against the source. May be omitted when empty. |
DrawingSearchPage¶
Field |
Type |
Description |
|---|---|---|
|
integer |
Associated positive page number. |
|
string |
Registered page image file ID. |
|
string |
Authenticated relative API path in the same environment. |
DrawingSearchDiagnostics¶
Field |
Type |
Description |
|---|---|---|
|
integer |
|
|
integer |
|
|
integer |
May be omitted when empty. |
|
integer |
May be omitted when empty. |
|
integer |
May be omitted when empty. |
|
integer |
|
|
integer |
|
|
string[] |
|
|
integer |
Number of merged candidate hits. |
|
integer |
Distinct source drawings among candidates, not the entire knowledge base count. |
|
integer |
Number of results in this response. |
|
boolean |
Whether identifier-related retrieval was attempted; not equivalent to exact mode. |
|
string[] |
Identifier hint extracted from query. May be omitted when empty. |
|
integer |
Identifier-related hit count. |
|
integer |
Filename identifier hit count. |
|
integer |
Text-layer identifier hit count. |
|
integer |
Vector-related hit count. |
Search-attached source objects copy gaps/pages; empty slices may encode as null, unlike [] returned by separate provenance objects. CLI may omit them further. Do not conflate null, [], and absence.