USD Search API is a collection of cloud-native microservices that enable developers, creators, and workflow specialists to efficiently search through vast collections of OpenUSD data, images, and other assets using natural language or image-based inputs.
With these production-ready microservices, developers can deploy USD Search API onto their own infrastructure. With USD Search API’s artificial intelligence (AI) features, you can quickly locate untagged and unstructured 3D data and digital assets, saving time navigating unstructured, untagged 3D data. USD Search API is capable of searching and indexing 3D asset databases, as well as navigating complex 3D scenes to perform spatial searches, without requiring manual tagging of assets.
For more information please refer to USD Search API documentation.
Asset Graph Search (AGS) provides advanced querying capabilities for assets and USD trees indexed in a graph database. It supports proximity queries based on coordinates or prims to find objects within specified areas or radii, sorted by distance, and includes transformation options for vector alignment. The API also offers dependency and reverse dependency searches, helping to identify all assets referenced in a scene or scenes containing a particular asset, which can optimize scene loading and track dependency changes. By combining different query types, the AGS API enables complex scenarios for scene understanding, manipulation, and generation. Integrated with USD Search it provides in-scene search functionality.
This Python package is automatically generated by the OpenAPI Generator project:
Python 3.8+
You can install the package directly using:
pip install usd-search-client --extra-index-url https://pypi.nvidia.com
Then import the package:
import usd_search_client
Please follow the installation procedure and then run the following:
import asyncio
import usd_search_client
from usd_search_client.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = usd_search_client.Configuration(
host = "http://api.my-usd-search-instance.example.com"
)
# The client may configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: APIKeyHeader
# configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyHeader'] = 'Bearer'
# Configure HTTP basic authorization: HTTPBasic
# configuration = usd_search_client.Configuration(
# username = os.environ["USERNAME"],
# password = os.environ["PASSWORD"]
# )
# Configure Bearer authorization: HTTPBearer
# configuration = usd_search_client.Configuration(
# access_token = os.environ["BEARER_TOKEN"]
# )
async def call_search_api(api_client_config):
# Enter a context with an instance of the API client
async with usd_search_client.ApiClient(api_client_config) as api_client:
# Create an instance of the API class
api_instance = usd_search_client.AISearchApi(api_client)
deep_search_search_request = usd_search_client.DeepSearchSearchRequest(description="box")
try:
# Search Post
api_response = await api_instance.search_post_v2_deepsearch_search_post(deep_search_search_request)
print("The response of AISearchApi->search_post_v2_deepsearch_search_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AISearchApi->search_post_v2_deepsearch_search_post: %s\n" % e)
asyncio.run(call_search_api(configuration))
All URIs are relative to http://api.my-usd-search-instance.example.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AGSAssetGraphApi | get_dependencies_flat_dependency_graph_flat_get | GET /dependency_graph/flat | Get Dependencies Flat |
| AGSAssetGraphApi | get_dependencies_graph_dependency_graph_graph_get | GET /dependency_graph/graph | Get Dependencies Graph |
| AGSAssetGraphApi | get_dependencies_inverse_dependency_graph_inverse_flat_get | GET /dependency_graph/inverse/flat | Get Dependencies Inverse |
| AGSAssetGraphApi | get_inverse_dependencies_graph_dependency_graph_inverse_graph_get | GET /dependency_graph/inverse/graph | Get Inverse Dependencies Graph |
| AGSSceneGraphApi | get_prims_asset_graph_usd_prims_get | GET /asset_graph/usd/prims | Get Prims |
| AGSSceneGraphApi | scene_summary_asset_graph_usd_scene_summary_get | GET /asset_graph/usd/scene_summary/ | Scene Summary |
| AGSSpatialGraphApi | get_prims_within_bounding_box_asset_graph_usd_prims_spatial_bbox_get | GET /asset_graph/usd/prims/spatial_bbox | Get Prims Within Bounding Box |
| AGSSpatialGraphApi | get_prims_within_radius_asset_graph_usd_prims_spatial_get | GET /asset_graph/usd/prims/spatial | Get Prims Within Radius |
| IndexingStatusApi | get_asset_status_info_indexing_asset_status_get | GET /info/indexing/asset/status | Get Asset Status |
| SearchApi | search_post_v2_deepsearch_search_post | POST /search | Search Post |
| SearchApi | search_v2_deepsearch_search_get | GET /search | Search |
Authentication schemes defined for the API:
FAQs
USD Search and Asset Graph Search APIs
We found that usd-search-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.