metadata-columns

Declare a metadata column

Changed on

(reserved for future use) Declares a metadata column to be materialized as a typed LanceDB column with a scalar index at the next ingestion. The key must be a column-safe identifier and the type must be "string" or "integer".

Required scope: `knowledge:write`

post/metadata_columns

Request

  • Base URL
    https://developer.qaip.com/api/v1
  • URL
    https://developer.qaip.com/api/v1/metadata_columns
  • Auth
    API key in header x-api-key

Request body

keystring required
type'string' | 'integer' | 'string_list' | 'integer_list' required
filter_onlyboolean
index_type'btree' | 'bitmap' | 'label_list'

Index type. Omit to use the type default (integer -> btree, string -> bitmap, string_list / integer_list -> label_list).

Response

Column declared

keystring required

Metadata key name (also the LanceDB column source name).

type'string' | 'integer' | 'string_list' | 'integer_list' required

Column type. Scalar-indexable types (string / integer) and array types string_list / integer_list (LanceDB List<Utf8> / List<Int64>, membership-filtered with array_has).

filter_onlyboolean

When true, the value is kept only as a LanceDB column for filtering and is not included in chunk bodies or API responses.

index_type'btree' | 'bitmap' | 'label_list'

Index type actually applied to the column. Defaults to BTREE for integer, BITMAP for string and LABEL_LIST for the array types when not specified at creation; override for cardinality (e.g. high-cardinality string -> btree). btree / bitmap are valid only for scalar types and label_list only for the array types.

created_atstring nullable

Changes

  • 2489c6f1a9d8Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • c4ae2348acf6Revision changes
    • warning

      added the new integer_list enum value to the response property for the response status

    • warning

      added the new label_list enum value to the response property for the response status

    • warning

      added the new string_list enum value to the response property for the response status

    • info

      added the new integer_list enum value to the request property

    • info

      added the new label_list enum value to the request property

    • info

      added the new string_list enum value to the request property