SemanticSearchToolset.SemanticSearchToolset

Toolset exposing the SemanticSearch plugin's hybrid vector + BM25 asset search to the AI Toolset Registry.

2 tool(s).

SemanticSearchToolset.SemanticSearchToolset.FindSimilar

Find assets whose embeddings are semantically similar to the given asset's embedding. Vector-only (no BM25). The source asset must already be indexed by the SemanticSearch plugin.

Input schema

{
  "properties": {
    "assetPath": {
      "description": "SoftObjectPath of the reference asset.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Object",
      "type": "object"
    },
    "classFilter": {
      "description": "Same semantics as Search::ClassFilter. See Search for the list of currently-indexed base classes. Pass an empty array for no class filter.",
      "items": {
        "properties": {
          "refPath": {
            "description": "The reference stored as a soft path string.",
            "type": "string"
          }
        },
        "required": [
          "refPath"
        ],
        "title": "Class@/Script/CoreUObject.Object",
        "type": "object"
      },
      "type": "array"
    },
    "k": {
      "default": 10,
      "description": "Maximum number of results to return. Must be >= 1. Defaults to 10.",
      "type": "integer"
    },
    "pathRegexes": {
      "description": "Same semantics as Search::PathRegexes. Pass an empty array for no path filter.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "assetPath",
    "classFilter",
    "pathRegexes"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Array of FSemanticSearchResult sorted by relevance (highest Score first)",
      "items": {
        "properties": {
          "caption": {
            "description": "Caption produced at index time by the SemanticSearch plugin.",
            "type": "string"
          },
          "class": {
            "description": "Class of the asset",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "Class@/Script/CoreUObject.Object",
            "type": "object"
          },
          "path": {
            "description": "Full asset path, e.g. \"/Game/Blueprints/BP_Foo.BP_Foo\".",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "/Script/CoreUObject.Object",
            "type": "object"
          }
        },
        "required": [
          "path",
          "class",
          "caption"
        ],
        "title": "SemanticSearchResult",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

SemanticSearchToolset.SemanticSearchToolset.Search

Run a semantic search over the Content Browser assets indexed by the SemanticSearch plugin.

Input schema

{
  "properties": {
    "classFilter": {
      "description": "If non-empty, array of classes to filter by (provide full ref path of the class). Passing a base class covers all its subclasses. The SemanticSearch index currently covers these base classes: Blueprint, StaticMesh, SkeletalMesh, Texture, Material, MaterialInstance. Pass an empty array to consider all indexed classes.",
      "items": {
        "properties": {
          "refPath": {
            "description": "The reference stored as a soft path string.",
            "type": "string"
          }
        },
        "required": [
          "refPath"
        ],
        "title": "Class@/Script/CoreUObject.Object",
        "type": "object"
      },
      "type": "array"
    },
    "k": {
      "default": 10,
      "description": "Maximum number of results to return. Must be >= 1. Defaults to 10.",
      "type": "integer"
    },
    "pathRegexes": {
      "description": "If non-empty, only assets whose soft object path matches at least one of these regular expressions are considered (e.g. \"^/Game/Blueprints/.*\"). Pass an empty array to consider all indexed paths.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "query": {
      "description": "Natural-language query. Must be non-empty.",
      "type": "string"
    }
  },
  "required": [
    "query",
    "classFilter",
    "pathRegexes"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Array of FSemanticSearchResult sorted by relevance (highest Score first)",
      "items": {
        "properties": {
          "caption": {
            "description": "Caption produced at index time by the SemanticSearch plugin.",
            "type": "string"
          },
          "class": {
            "description": "Class of the asset",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "Class@/Script/CoreUObject.Object",
            "type": "object"
          },
          "path": {
            "description": "Full asset path, e.g. \"/Game/Blueprints/BP_Foo.BP_Foo\".",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "/Script/CoreUObject.Object",
            "type": "object"
          }
        },
        "required": [
          "path",
          "class",
          "caption"
        ],
        "title": "SemanticSearchResult",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}