Skip to content

Add GetDetections3D to the vision service API reference - #5431

Merged
Eliza Farley (elizafarley) merged 3 commits into
mainfrom
claude/update-vision-get-detections-3d
Oct 16, 2026
Merged

Eliza Farley (elizafarley) merged 3 commits into
mainfrom
claude/update-vision-get-detections-3d

Conversation

@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Source changes

  • RSDK-14579 — rdk#6583: GetDetections3D in the Go vision service, client and server (in RDK v1.12.0)
  • RSDK-14579 — viam-python-sdk get_detections_3d (in v0.84.0), viam-flutter-sdk#570 detections3D (in v0.22.1), viam-typescript-sdk#1022 getDetections3D (in v0.77.0)

No DOCS ticket matched RSDK-14579 or its parent (Jira query over all four attachment shapes).

Docs changes

  • .github/workflows/sdk_protos_map.csv: adds vision,GetDetections3D,,get_detections_3d,GetDetections3D,detections3D,getDetections3D.
  • static/include/services/apis/overrides/protos/vision.GetDetections3D.md: new one-sentence description, from the proto comment on rpc GetDetections3D.
  • static/include/services/apis/generated/vision.md and vision-table.md: regenerated with update_sdk_methods.py "" vision. Adds the GetDetections3D section with Python, Go, TypeScript and Flutter tabs.

Other hunks the regeneration produced, each checked against the latest release tag and kept because it is released:

  • CaptureAllFromCamera: Python return_detections_3d (in v0.84.0), TypeScript detections3d result and returnDetections3d option (in v0.77.0).
  • GetProperties: TypeScript detections3dSupported (in v0.77.0).

The Python example (VisionClient.from_robot(robot=machine, "my_detector")) comes from the SDK docstring, which passes a positional argument after a keyword one. Fixing that belongs in viam-python-sdk.

How I found these

  • Xref lookup: service-api-xref.md (vision service)
  • Backlog item rdk-fef9ce6-vision-get-detections-3d, held back by the 5-PR cap on 2026-10-14 and 2026-10-15. The SDK release and docs-site gates were re-checked today.

Checks: vale 3.12.0 on the changed files, frontmatter_rules.py, make build-prod all pass. Prettier and markdownlint do not cover static/.


Generated by daily docs change agent


Generated by Claude Code

RSDK-14579: GetDetections3D is released in Go (RDK v1.12.0), Python (v0.84.0),
Flutter (v0.22.1) and TypeScript (v0.77.0). Add the CSV row and proto override,
and regenerate vision.md with update_sdk_methods.py.
@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 202d696
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ad2844b1846c18a362b29e8
😎 Deploy Preview https://deploy-preview-5431--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 38 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Oct 16, 2026
@elizafarley

Eliza Farley (elizafarley) commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Docs review: Ready to merge

Adds GetDetections3D to the vision service API reference and picks up the related released fields on CaptureAllFromCamera and GetProperties. Since the last review, 202d696 adds the method to the hand-written method lists on three pages. Generated files still come from the CSV row and proto override, and every signature matches the tagged SDK releases.

CI: All required checks passing

Docs health: No regressions (3 pages compared)

Nits

  • docs/reference/apis/services/vision.md:89: this is the only bullet in any "Supported API methods" list on the page that carries a description, and at that length it reads unevenly next to the bare links above it. Fix: optionally trim it to the link alone, or move the explanation into the Segmentations paragraph.
  • docs/reference/apis/services/vision.md:21: the intro still says the API returns "detections, classifications, or point cloud objects" (the frontmatter description: says the same). Fix: optionally add "3D detections."

The Python from_robot(robot=machine, "my_detector") syntax error and the Go mySegmenterService name come from SDK docstrings. The author has logged them for upstream, so this review doesn't track them.

Verified against source (10 claims)
  • Go GetDetections3D(ctx, cameraName string, extra map[string]interface{}) ([]*detection3d.Detection, error): viamrobotics/rdk services/vision/vision.go:229, first released in v1.12.0
  • Go example's d.Transforms is []*referenceframe.LinkInFrame: viamrobotics/rdk vision/detection3d/detection3d.go:26
  • Go example's referenceframe.NewWorldState(nil, transforms): viamrobotics/rdk referenceframe/worldstate.go:34
  • Override description and new method-list text ("tree of named transforms… can be passed into a frame system or a motion WorldState") match the proto comment: viamrobotics/api proto/viam/service/vision/v1/vision.proto:40-43
  • Python get_detections_3d(camera_name, *, extra, timeout) -> list[Detection3D]: viamrobotics/viam-python-sdk src/viam/services/vision/client.py:170 at v0.84.0
  • Python capture_all_from_camera(..., return_detections_3d): viamrobotics/viam-python-sdk src/viam/services/vision/client.py:56 at v0.84.0
  • TypeScript getDetections3D(cameraName, extra, callOptions): viamrobotics/viam-typescript-sdk src/services/vision/client.ts:131 at v0.77.0
  • TypeScript returnDetections3d option, detections3d result, and detections3dSupported property: viamrobotics/viam-typescript-sdk src/services/vision/client.ts:158,169,194 at v0.77.0
  • Flutter detections3D(String cameraName, {Map<String, dynamic>? extra}) -> Future<List<Detection3D>>: viamrobotics/viam-flutter-sdk lib/src/services/vision.dart:112 at v0.22.1
  • #getdetections3d anchor used in all three new links resolves to the generated ### GetDetections3D heading

Automated review by Claude. Rerunning the review updates this comment.

Copy link
Copy Markdown
Collaborator Author

Thanks.

  • Method lists: fixed in 202d696, in this PR rather than a follow-up because it's the same source change. GetDetections3D is now in the API page's Segmentations "Supported API methods" list, in the method list in docs/vision/overview.md, and in the method list on docs/reference/services/vision/_index.md.
  • Python from_robot(robot=machine, "my_detector") example: this comes from the viam-python-sdk docstrings, and the docs agent doesn't write to source repos. I'm leaving it for the SDK team and noting it in the docs-agent backlog so the page gets regenerated once the docstrings are fixed.
  • Go mySegmenterService name: same for the rdk docstring. It stays as generated.

Generated by Claude Code

Copy link
Copy Markdown
Collaborator Author

Thanks. I am leaving both optional nits as they are, so the approved head does not change. The description on the Segmentations bullet matches the proto comment, and adding "3D detections" to the intro would ride along with any later push to this PR.


Generated by Claude Code

@elizafarley
Eliza Farley (elizafarley) merged commit 3e99138 into main Oct 16, 2026
13 checks passed
@elizafarley
Eliza Farley (elizafarley) deleted the claude/update-vision-get-detections-3d branch October 16, 2026 20:59
@github-actions

Copy link
Copy Markdown

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants