Search Post

post

https://ai.api.nvidia.com/v1/omniverse/nvidia/usdsearch

Body Params

description

string

Conduct text-based searches powered by AI

image_similarity_search

string

Perform similarity searches based on images

file_name

string

Filter results by asset file name, allowing partial matches. Use wildcards: * for any number of characters, ? for a single character. Separate terms with , for OR and ; for AND.

exclude_file_name

string

Exclude results by asset file name, allowing partial matches. Use wildcards: * for any number of characters, ? for a single character. Separate terms with , for OR and ; for AND.

file_extension_include

string

Filter results by file extension. Use wildcards: * for any number of characters, ? for a single character. Separate terms with , for OR and ; for AND.

file_extension_exclude

string

Exclude results by file extension. Use wildcards: * for any number of characters, ? for a single character. Separate terms with , for OR and ; for AND.

created_after

string

Filter results to only include assets created after a specified date

created_before

string

Filter results to only include assets created before a specified date

modified_after

string

Filter results to only include assets modified after a specified date

modified_before

string

Filter results to only include assets modified before a specified date

file_size_greater_than

string

Filter results to only include files larger than a specific size

file_size_less_than

string

Filter results to only include files smaller than a specific size

created_by

string

Filter results to only include assets created by a specific user. In case AWS S3 bucket is used as a storage backend, this field corresponds to the owner's ID. In case of an Omniverse Nucleus server, this field may depend on the configuration, but typically corresponds to user email.

exclude_created_by

string

Exclude assets created by a specific user from the results

modified_by

string

Filter results to only include assets modified by a specific user. In the case, when AWS S3 bucket is used as a storage backend, this field corresponds to the owner's ID. In case of an Omniverse Nucleus server, this field may depend on the configuration, but typically corresponds to user email.

exclude_modified_by

string

Exclude assets modified by a specific user from the results

similarity_threshold

number

0 to 2

Set the similarity threshold for embedding-based searches. This functionality allows filterring duplicates and returning only those results that are different from each other. Assets are considered to be duplicates if the cosine distance betwen the embeddings a smaller than the similarity_threshold value, which could be in the [0, 2] range.

cutoff_threshold

number

≥ 0

Set the cutoff threshold for embedding-based searches

search_path

string

Specify the search path within the storage backend. This path should not contain the storage backend URL, just the asset path on the storage backend. Use wildcards: * for any number of characters, ? for a single character. Separate terms with , for OR and ; for AND.

search_in_scene

string

Conduct the search within a specific scene. Provide the full URL for the asset including the storage backend URL prefix.

filter_by_properties

string

Filter assets by USD attributes where at least one root prim matches (note: only supported for a subset of attributes indexed). Format: attribute1=abc,attribute2=456

min_bbox_x

number

Filter by minimum X axis dimension of the asset's bounding box

min_bbox_y

number

Filter by minimum Y axis dimension of the asset's bounding box

min_bbox_z

number

Filter by minimum Z axis dimension of the asset's bounding box

max_bbox_x

number

Filter by maximum X axis dimension of the asset's bounding box

max_bbox_y

number

Filter by maximum Y axis dimension of the asset's bounding box

max_bbox_z

number

Filter by maximum Z axis dimension of the asset's bounding box

return_images

boolean

Defaults to false

Return images if set to True

return_metadata

boolean

Defaults to false

Return metadata if set to True

return_root_prims

boolean

Defaults to false

Return root prims if set to True

return_predictions

boolean

Defaults to false

Return predictions if set to True

return_in_scene_instances_prims

boolean

Defaults to false

[in-scene search only] Return prims of instances of objects found in the scene

embedding_knn_search_method

string

enum

An enumeration.

Allowed:

limit

integer

1 to 10000

Set the maximum number of results to return from the search, default is 32

vision_metadata

string

Input string for the vision metadata query

return_vision_generated_metadata

boolean

Defaults to false

Return vision generated metadata if True

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Search results

202Result is pending. Client should poll using the requestId.

402Payment Required

422Validation Error

500The invocation ended with an error.