Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-3191 Add/remove tags on binary data #4218

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOCS-3191 Add/remove tags on binary data #4218

wants to merge 1 commit into from

Conversation

IanWhalen
Copy link
Contributor

Context

POC of using Claude to update docs. TBH this looks like a real miss to me (I think we actually wanted to update https://docs.viam.com/dev/tools/cli/?) but I think that's because my vector search is what failed, not the interaction with claude:

2025-04-11 19:16:30 [info     ] Performing vector search       [ai_client] query='Updating tags on binary data, adding binary data to datasets, removing binary data from datasets, running ML inference on binary data' top_k=5

our vector query didn't actual include "CLI".

Tool Output

--- Proposed Documentation Actions ---
Summary: The main changes are:

  1. Removing the org_id and location_id flags when tagging, adding, or removing binary data. The binary data ID itself is now sufficient.
  2. Renaming file_id and file_ids flags to binary_data_id and binary_data_ids.
  3. Updating the inference command to use the binary_data_id flag instead of separate file_id, file_org_id, and file_location_id flags.
    Reasoning:
    The retrieved relevant documentation sections covered adding/removing tags from binary data by ID or by filter, but did not have the updated content reflecting the removal of org_id and location_id requirements, and the renaming of file_id/file_ids to binary_data_id/binary_data_ids.

To address the changes in the diff, I updated the content for data.AddTagsToBinaryDataByIDs.md and data.RemoveTagsFromBinaryDataByIDs.md to use the new binary_data_ids field instead of file_ids, org_id, and location_id. I preserved the existing descriptions but updated the proto message definitions to match the new API.

I did not find any existing documentation sections specifically covering the inference command changes, so I did not generate an edit for that portion of the diff. The reasoning is that by updating the tag adding/removing docs, users will be able to infer how to use the new binary_data_id flag for inference as well.
Planned Edits:

  • UPDATE: static/include/app/apis/overrides/protos/data.AddTagsToBinaryDataByIDs.md (376 bytes)
  • UPDATE: static/include/app/apis/overrides/protos/data.RemoveTagsFromBinaryDataByIDs.md (416 bytes)
    --- End of Plan ---

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Apr 11, 2025
Copy link

netlify bot commented Apr 11, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit ca2f573
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/67f9a85a235036000885390d
😎 Deploy Preview https://deploy-preview-4218--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: 44 (🟢 up 7 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

@IanWhalen
Copy link
Contributor Author

obviously I just expect this to get closed, but I thought it was at least interesting to include as an example of what this could look like.

@IanWhalen
Copy link
Contributor Author

also worth noting: this PR cost ~$1 to generate.

@IanWhalen
Copy link
Contributor Author

@npentrel now that I've had a chance to think on this, I do have a request for you here:

could you look at https://viam.atlassian.net/browse/DATA-3948 as well as the broader epic and let me know if you think it makes sense to do a docs change on this PR alone or if it would need to be on the broader epic? Right now I'm trying to get to a reproducible eval case on step 1 in the pipeline - given an input of content (PRs, scopes, whatever), i want to make sure that we are identifying the correct files to update.

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.

2 participants