mex.backend.extracted package

Submodules

mex.backend.extracted.helpers module

mex.backend.extracted.helpers.get_extracted_item_from_graph(identifier: Identifier) → ExtractedAccessPlatform | ExtractedActivity | ExtractedBibliographicResource | ExtractedConsent | ExtractedContactPoint | ExtractedDistribution | ExtractedOrganization | ExtractedOrganizationalUnit | ExtractedPerson | ExtractedPrimarySource | ExtractedResource | ExtractedVariable | ExtractedVariableGroup

Fetch and return the extracted item for the given identifier.

mex.backend.extracted.helpers.get_extracted_items_from_graph(*, stable_target_id: Identifier | None = None, entity_type: Sequence[str] | None = None, limit: int = 100) → list[ExtractedAccessPlatform | ExtractedActivity | ExtractedBibliographicResource | ExtractedConsent | ExtractedContactPoint | ExtractedDistribution | ExtractedOrganization | ExtractedOrganizationalUnit | ExtractedPerson | ExtractedPrimarySource | ExtractedResource | ExtractedVariable | ExtractedVariableGroup]

Get a list of extracted items for the given id and type.

Parameters:

  • stable_target_id – Optional stable target ID filter

  • entity_type – Optional entity type filter

  • limit – How many items to return at most

Raises:

InconsistentGraphError – When the graph response cannot be parsed

Returns:

List of extracted items

mex.backend.extracted.helpers.search_extracted_items_in_graph(*, query_string: str | None = None, stable_target_id: Identifier | None = None, entity_type: Sequence[str] | None = None, referenced_identifiers: list[str] | None = None, reference_field: str | None = None, skip: int = 0, limit: int = 100) → PaginatedItemsContainer[ExtractedAccessPlatform | ExtractedActivity | ExtractedBibliographicResource | ExtractedConsent | ExtractedContactPoint | ExtractedDistribution | ExtractedOrganization | ExtractedOrganizationalUnit | ExtractedPerson | ExtractedPrimarySource | ExtractedResource | ExtractedVariable | ExtractedVariableGroup]

Search for extracted items in the graph.

Parameters:

  • query_string – Full text search query term

  • stable_target_id – Optional stable target ID filter

  • entity_type – Optional entity type filter

  • referenced_identifiers – Optional merged item identifiers filter

  • reference_field – Optional field name to filter for

  • skip – How many items to skip for pagination

  • limit – How many items to return at most

Raises:

InconsistentGraphError – When the graph response cannot be parsed

Returns:

Paginated list of extracted items

mex.backend.extracted.main module

mex.backend.extracted.main.get_extracted_item(identifier: Identifier) → ExtractedAccessPlatform | ExtractedActivity | ExtractedBibliographicResource | ExtractedConsent | ExtractedContactPoint | ExtractedDistribution | ExtractedOrganization | ExtractedOrganizationalUnit | ExtractedPerson | ExtractedPrimarySource | ExtractedResource | ExtractedVariable | ExtractedVariableGroup

Return one extracted item for the given identifier.

mex.backend.extracted.main.search_extracted_items(q: Annotated[str, Query(PydanticUndefined)] = '', stableTargetId: Annotated[Identifier | None, Query(PydanticUndefined)] = None, entityType: Annotated[Sequence[ExtractedType], Query(PydanticUndefined)] = [], hadPrimarySource: Annotated[Sequence[Identifier] | None, Query(PydanticUndefined)] = None, referencedIdentifier: Annotated[Sequence[Identifier] | None, Query(PydanticUndefined)] = None, referenceField: Annotated[ReferenceFieldName | None, Query(PydanticUndefined)] = None, skip: Annotated[int, Query(PydanticUndefined)] = 0, limit: Annotated[int, Query(PydanticUndefined)] = 10) → PaginatedItemsContainer[ExtractedAccessPlatform | ExtractedActivity | ExtractedBibliographicResource | ExtractedConsent | ExtractedContactPoint | ExtractedDistribution | ExtractedOrganization | ExtractedOrganizationalUnit | ExtractedPerson | ExtractedPrimarySource | ExtractedResource | ExtractedVariable | ExtractedVariableGroup]

Search for extracted items by query text or by type and id.

Module contents