RecallsSimilaritySearchRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/deeprecall-io/json-schema/deeprecall-io-recalls-similarity-search-request-schema.json",
  "title": "RecallsSimilaritySearchRequest",
  "description": "Request for similarity search in the recalls database.\n\nFind recalled products similar to your query using AI-powered multimodal matching.\n\n**Input Options (provide at least one):**\n- `content_description`: Text description of the product\n- `image_urls`: List of product image URLs (1-10 images)\n\n**Fusion Models:**\n- `fuse_max` (default, recommended): Boosts items found in multiple modalities\n- `fuse_flex`: Flexible user-controlled weighting\n- `fuse`: Simple baseline fusion\n\n**Credits:** Each search consumes 1 API credit.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/deeprecall-io-openapi.json#/components/schemas/RecallsSimilaritySearchRequest",
  "properties": {
    "content_description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000,
          "minLength": 3
        },
        {
          "type": "null"
        }
      ],
      "title": "Content Description",
      "description": "Text description of the product to search for"
    },
    "image_urls": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array",
          "maxItems": 10,
          "minItems": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Image Urls",
      "description": "List of product image URLs (1-10 images)"
    },
    "filter_by_data_sources": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Filter By Data Sources",
      "description": "Filter results by data sources (e.g., ['safety_gate', 'us_cpsc']). If not provided, uses your authorized sources."
    },
    "top_k": {
      "type": "integer",
      "maximum": 100.0,
      "minimum": 1.0,
      "title": "Top K",
      "description": "Number of results to return (default: 10, max: 100)",
      "default": 10
    },
    "model_name": {
      "type": "string",
      "title": "Model Name",
      "description": "Fusion model for combining text and image scores. Options: fuse_max (recommended), fuse_flex, fuse",
      "default": "fuse_max"
    },
    "input_weights": {
      "items": {
        "type": "number"
      },
      "type": "array",
      "title": "Input Weights",
      "description": "Weights for [text, images] modalities. Must sum to 1.0. Default: [0.5, 0.5]",
      "default": [
        0.5,
        0.5
      ]
    }
  },
  "type": "object"
}