Query Component

The Query Component of needlectl allows you to interact with Needle’s image retrieval capabilities. It lets you execute natural language queries, view query logs, and configure query-related settings.

Commands Overview

run

This command executes a search query against the Needle image retrieval database.

• Options:

  • prompt (string): The search prompt in natural language.
  • -n (integer, optional): Specifies the number of images to retrieve.
  • --num-images-to-generate (integer, optional): Specifies the number of images to generate.
  • --num-engines (integer, optional): Specifies the number of engines to use.
  • --image-size (string, optional): Sets the desired image size for image generation (e.g., “512”, “1024”).
  • --include-base-images (boolean, optional): Indicates whether to include base images in the results preview.
  • --use-fallback (boolean, optional): Indicates whether to use fallback mode if the primary engines set fails.

• What It Does:

  1. Retrieves the enabled and activated generator configurations using the Generator Config Manager.
  2. If no generator configuration is found, it displays an error message suggesting you use needlectl generator config to configure a generator.
  3. Executes the search query with the provided parameters via the backend API.
  4. Displays the search results in the specified output format (human-readable, JSON, or YAML).

• Usage Examples:

  # Run a basic query with a prompt
  needlectl query run "red cars"
  
  # Run a query with additional options
  needlectl query run "red cars" -n 5 --num-images-to-generate 2 --num-engines 3 --image-size 512 --include-base-images true --use-fallback false
  
  # Run a query with JSON output
  needlectl --output json query run "mountain landscape" -n 10
  

log

This command retrieves and displays the logs of search queries executed by Needle.

• Usage Examples:

  needlectl query log
  

config

This command manages the environmental configuration for the query component.

• Usage Examples:

  needlectl query config