Skip to content

Latest commit

 

History

History
 
 

search

README.md

Dataset viewer API - search and filter endpoints

GET /search

GET /filter

See search and filter usage for more details.

Configuration

The service can be configured using environment variables. They are grouped by scope.

Duckdb index

  • DUCKDB_INDEX_CACHE_DIRECTORY: directory where the temporal duckdb index files are downloaded. Defaults to empty.
  • DUCKDB_INDEX_TARGET_REVISION: the git revision of the dataset where the index file is stored in the dataset repository.
  • DUCKDB_INDEX_EXTENSIONS_DIRECTORY: directory where the duckdb extensions will be downloaded. Defaults to empty.

API service

See ../../libs/libapi/README.md for more information about the API configuration.

Common

See ../../libs/libcommon/README.md for more information about the common configuration.

Endpoints

See https://huggingface.co/docs/dataset-viewer

  • /healthcheck: ensure the app is running
  • /metrics: return a list of metrics in the Prometheus format
  • /search: get a slice of a search result over a dataset split
  • /filter: filter rows of a dataset split