The Entity Search API enables the identification of specific entities, such as persons, within video content.

Key features:

• Quick identification: Use a simple query syntax to perform accurate searches, enabling rapid identification of individuals in video content.
• Efficient organization: Create, update, and delete entity collections and entities to streamline the management of individuals.
• Improved accuracy: Add and remove image assets to enhance the ability of the platform to identify individuals.

Use cases:

• Sports: Identify players in game footage to create highlight videos or analyze performance.
• Movies: Track characters across scenes to measure screen time or generate related content.
• Surveillance: Locate individuals in security footage to analyze behavior or find missing persons.

Ensure you understand the concepts below using the Entity Search API:

• Assets: Represent the reference images that define each entity. The quality and variety of these images significantly affect search accuracy. The platform performs better when you provide multiple images of the person wearing different outfits, taken under various lighting conditions, and from different angles.
• Entity collections: Organize related entities into logical groups. Collections are conceptually similar to indexes and act as containers that hold multiple entities belonging together. For example, an entity collection for a soccer team may contain various entities that are the individual soccer players.
• Entities: Represent specific persons that you want to find in your videos. Each entity is part of an entity collection and contains one or more assets that help identify the person. Entities serve as the searchable units. and you can reference them in your search queries.

Follow the steps below to use the Entity Search API:

Prerequisites

• You already know how to perform search requests. For instructions, see the Search page.

Upload assets

• The images you wish to upload must meet the following requirements:
  • Format: JPEG and PNG.
  • Dimension: Must be at least 64 x 64 pixels.
  • Size: Must not exceed 5MB.

To upload assets…

1

Create an entity collection

To create an entity collection…

1

Create an entity

To create an entity…

1

Perform a search request

To perform a search request…

Note that you can reference up to two entities in your search query.

1