HUhuggingface

Full-text search in the text columns of a split

Changed on

Returns the rows matching the query, ordered by row index. Up to 100 rows are returned. The offset and length parameters allow to navigate the results.

get/search

Request

  • Base URL
    https://datasets-server.huggingface.co
  • URL
    https://datasets-server.huggingface.co/search
  • Auth
    • none
    • or HTTP bearer
    • or HTTP bearer

Query parameters

datasetstring required

The identifier of the dataset on the Hub.

configstring required

The dataset subset (also called 'configuration').

splitstring required

The split name.

querystring required

The search query.

offsetinteger

The offset of the returned rows.

lengthinteger

The maximum number of returned rows

Response

The <a href='https://huggingface.co/docs/datasets/about_dataset_features'>features</a>, and the list of rows that match the search query. The query will only be searched among the string columns. Bytes columns are not supported at the moment, and their content will be 'null'.

num_rows_totalinteger required
num_rows_per_pageinteger required
partialboolean required

Changes

  • 93120a37c491Revision changes
    • breaking

      added to the /// response property oneOf list for the response status

    • breaking

      added to the // response property oneOf list for the response status

  • fb2a779e8e62Revision changes
    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      the ////// response's property type changed from array to object for status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status