Extract

matchbox.client.extract

Functions to extract data out of the Matchbox server.

Functions:

• key_field_map –

  Return matchbox IDs to source key mapping, optionally filtering.

key_field_map

key_field_map(
    resolution: ModelResolutionName,
    source_filter: list[SourceResolutionName]
    | SourceResolutionName
    | None = None,
    uri_filter: list[str] | str | None = None,
) -> Table

Return matchbox IDs to source key mapping, optionally filtering.

Parameters:

• resolution

  (ModelResolutionName) –

  The resolution name to use for the query.

• source_filter

  (list[SourceResolutionName] | SourceResolutionName | None, default: None ) –

  A substring or list of substrings to filter source names.

• uri_filter

  (list[str] | str | None, default: None ) –

  A substring or list of substrings to filter location URIs.