MLKitEntityExtraction Framework Reference

Page Summary

• The Entity Extraction API provides functions to access supported entity types and model identifiers.

• MLKEntityExtractionEntityTypeAllEntityTypes returns all supported entity types.

• MLKEntityExtractionAllModelIdentifiers returns all supported model identifiers.

• Functions are available to retrieve language tags for model identifiers and vice-versa.

Functions

The following functions are available globally.

• MLKEntityExtractionEntityTypeAllEntityTypes

  Returns a set that contains EntityType codes of all entity types supported by the entity extraction API.

  Declaration

  Objective-C

  NSSet<MLKEntityExtractionEntityType>
      *_Nonnull MLKEntityExtractionEntityTypeAllEntityTypes()

• MLKEntityExtractionAllModelIdentifiers

  Returns a set that contains EntityExtractionModelIdentifier values of all model identifiers supported by the Entity Extraction API.

  Declaration

  Objective-C

  NSSet<MLKEntityExtractionModelIdentifier>
      *_Nonnull MLKEntityExtractionAllModelIdentifiers()

• MLKEntityExtractionLanguageTagForModelIdentifier

  Returns the BCP 47 language tag for this EntityExtractionModelIdentifier.

  Declaration

  Objective-C

  NSString *_Nonnull MLKEntityExtractionLanguageTagForModelIdentifier(
      MLKEntityExtractionModelIdentifier _Nonnull modelIdentifier)

• MLKEntityExtractionModelIdentifierForLanguageTag

  Returns the EntityExtractionModelIdentifier for a given BCP 47 language tag, or nil if the language tag is invalid or not supported by the Entity Extraction API.

  Declaration

  Objective-C

  MLKEntityExtractionModelIdentifier _Nullable MLKEntityExtractionModelIdentifierForLanguageTag(
      NSString *_Nonnull languageTag)