A collection of code samples for interfacing with USD Search API.
USD Search is an AI-powered search for OpenUSD data, 3D models, images, and assets using text or image input. It is a collection of cloud-native microservices that help users navigate unstructured, untagged 3D data. It is capable of searching and indexing 3D asset databases, searching in-scene, and performing spatial searches, without requiring any manual tagging of assets.
- USD Search Window - a simple, dockable UI for GUI Kit Apps.
The workflow is broken down into key steps :
- Obtain API Key and store in safe location.
- Clone and Create Application (DO NOT BUILD).
- Clone and Configure Extensions from this repo.
- Build and Launch Kit Template Application.
Click to get API Key - add to NVIDIA_API_KEY env.variable NOW or extension.toml files LATER.
NOTE : Restart relevant kit-app terminals after changing environment variables.
CREATE - BUT DON'T BUILD OR LAUNCH APPLICATION
Click for instructions - to clone kit-app-template and create app (if you haven't already).
Navigate to parent directory of kit-app-template and clone this extension repo.
Execute using powershell in Windows or terminal in Linux / MacOS
git clone https://github.com/NVIDIA-Omniverse/usdsearch-samples
NOTE : You may also use Code drop-down in repo webpage to extract to desired location.
Using Command Line or File Manager:
Copy contents from usdsearch-samples/exts/ to kit-app-template/source/extensions/
You may skip this part if you configured NVIDIA_API_KEY environment variable.
Open config/extension.toml in each copied folder and look for Put API Key Here comment.
Paste your key into quotes and save.
Open new (or existing) [kit_app_name].kit file in kit-app-template/source/apps/
Add the following under [dependencies]:
"omni.kit.window.usd_search" = {}
Ensure API Key is in NVIDIA_API_KEY environment variable or extension.toml
Click for instructions - to continue building and launching your kit-application.
NOTE: You must build
kit-app-templateto register new extensions.
Usd Search Documentation - here
Using S3 urls with Omniverse - here
Details on omniverse.toml file - here
This repository contains software governed by the LICENSE and NVIDIA Omniverse software and materials. NVIDIA Omniverse is governed by the NVIDIA Agreements | Enterprise Software | NVIDIA Software License Agreement and NVIDIA Agreements | Cloud Services | Service-Specific Terms for NVIDIA Omniverse Cloud. By downloading or using NVIDIA Omniverse, you agree to the NVIDIA Omniverse terms