Interface ListFilesOptions

Options for filtering files in the list operation.

interface ListFilesOptions {
    filter?: object;
}

Properties

Properties

filter?: object

Optionally filter files by metadata. Uses Pinecone's metadata filter language: fields are referenced at the top level (not wrapped in a metadata key), and may be combined with operators like $eq, $ne, $gt, $lt, $in.

filter: { version: 'v1' }
filter: { version: { $eq: 'v1' } }
filter: { version: 'v1', tier: { $in: ['gold', 'silver'] } }

Metadata filter language

Filters that don't match Pinecone's expected shape (e.g. wrapping fields in a top-level metadata key like { metadata: { version: 'v1' } }) are silently ignored server-side and return the unfiltered file list.