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] | None = None,
location_names: list[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] | None
, default:None
) –An optional list of source resolution names to filter by.
-
location_names
¶list[str] | None
, default:None
) –An optional list of location names to filter by.