⚠️ This Repository Is Archived

Thank you for your interest in this project.

This repository is no longer maintained or updated.

For the latest code, contributions, and support, please visit the actively maintained repository here:

CluedIn-io/CluedIn.Magic.Py

---

CluedIn IPython magic commands

This module provides IPython magic commands for interacting with the CluedIn API.

# Install the package.
%pip install cluedin-magic

# Load the extension.
%load_ext cluedin_magic

# Create a new CluedIn context from a JWT token.
api_token = '<your_token_here>'
ctx = %cluedin get-context --jwt %api_token

# Find all entities with a specific entityType.
%cluedin search --context ctx --query +entityType:/Infrastructure/User

# Find all entities with a specific entityType and limit the results.
%cluedin search --context ctx --query +entityType:/Infrastructure/User --limit 10

# Complex query with multiple properties and limit the results.
%cluedin search --context ctx --query +entityType:/IMDb/Name -properties.imdb.name.deathYear:"\\\\N" --limit 10

# Save the results of a query to a pandas DataFrame.
pd = %cluedin search --context ctx --query +entityType:/IMDb/Name +properties.imdb.name.birthYear:1981