Content Quality Analysis in Jupyter Notebooks

1
# Install the official Acrolinx NextGen API package
2
!pip install acrolinx-nextgen-api
3
4
from acrolinx import Acrolinx
5
import json
6
import time
7
import tempfile
8
import os
9
10
print("✅ Acrolinx SDK imported successfully!")

1
# ❗ FOR YOU: Put your API key here
2
ACROLINX_API_KEY = "your-api-key-here"
3
4
# Initialize the Acrolinx client
5
client = Acrolinx(
6
    token=ACROLINX_API_KEY,
7
)
8
9
print("🚀 Acrolinx SDK client initialized!")

1
# ❗ FOR YOU: Put the text you want to check here
2
# Sample text to analyze - a business communication about remote work
3
sample_text = """
4
Remote work has fundamentally transformed how organiztions operate in the modern busness landscape. Companies worldwide have discovered that distributed teams can maintain high levels of productivity while offering employees greater flexibility and work-life balance. This shift has necessitated the adoption of new technologies, communication protocols, and management strategies to ensure seamless collaboration across different time zones and locations.
5
6
However, the transition to remote work also presents unique challenges that require careful consideration. Issues such as maintaining team cohesion, ensuring effective knowledge transfer, and preserving company culture become more complex when employees are physically separated. Organizations that successfully navigate these challenges typically invest in robust digital infrastructure, establish clear communication guidelines, and prioritize regular virtual team-building activities to foster meaningful connections among team members.
7
""".strip()
8
9
print("📝 Sample text prepared:")
10
print("-" * 60)
11
print(sample_text)
12
print("-" * 60)
13
print(f"Text length: {len(sample_text)} characters")

1
# ❗ FOR YOU: Choose your parameters for the check and set them here
2
# See the docs for allowed values
3
4
style_guide = "microsoft"
5
tone = "business"
6
dialect = "american_english"

1
# Create a style check using the SDK
2
print("🔍 Creating style check with Acrolinx SDK...")
3
4
try:
5
    # Create temporary file for upload (API requires file upload)
6
    with tempfile.NamedTemporaryFile(mode='w', suffix='.txt', delete=False) as tmp_file:
7
        tmp_file.write(sample_text)
8
        temp_file_path = tmp_file.name
9
10
    print(f"📁 Created temporary file: {temp_file_path}")
11
12
    # Submit the document for analysis
13
    with open(temp_file_path, 'rb') as file_obj:
14
        check_response = client.style_suggestions.create_style_suggestion(
15
            file_upload=file_obj,
16
            style_guide=style_guide,
17
            tone=tone,
18
            dialect=dialect
19
        )
20
21
    # Clean up temporary file
22
    os.unlink(temp_file_path)
23
    print("🗑️ Temporary file cleaned up")
24
25
    # Display initial response
26
    print("\n📊 Style Check Submitted:")
27
    print(f"Status: {check_response.status}")
28
    print(f"Workflow ID: {check_response.workflow_id}")
29
30
    # Store workflow ID for polling
31
    workflow_id = check_response.workflow_id
32
33
except Exception as e:
34
    print(f"❌ Error creating style check: {e}")
35
    # Clean up if error occurs
36
    if 'temp_file_path' in locals() and os.path.exists(temp_file_path):
37
        os.unlink(temp_file_path)
38
        print("🗑️ Temporary file cleaned up after error")

1
# Poll for completion and get results
2
if 'workflow_id' in locals():
3
    print(f"⏳ Polling for completion of workflow: {workflow_id}")
4
5
    max_attempts = 15
6
    for attempt in range(max_attempts):
7
        try:
8
            # Check status
9
            result = client.style_suggestions.get_style_suggestion(workflow_id=workflow_id)
10
11
            print(f"   Attempt {attempt + 1}: Status = {result.status}")
12
13
            if result.status == 'completed':
14
                print("\n✅ Analysis completed!")
15
                final_result = result
16
                break
17
            elif result.status == 'failed':
18
                print("\n❌ Analysis failed!")
19
                break
20
21
            # Wait before next attempt
22
            time.sleep(3)
23
24
        except Exception as e:
25
            print(f"   Error on attempt {attempt + 1}: {e}")
26
            # If we get validation errors, try to continue polling
27
            if "validation error" in str(e).lower():
28
                print("   (Continuing despite validation error...)")
29
                time.sleep(3)
30
                continue
31
            else:
32
                break
33
34
    if attempt >= max_attempts - 1:
35
        print("⏰ Timeout waiting for completion")
36
else:
37
    print("❌ No workflow_id available")

1
print("\n" + "=" * 60)
2
print("📋 ACROLINX ANALYSIS RESULTS")
3
print("=" * 60)
4
5
scores = final_result.scores
6
print("📊 Quality Scores:")
7
print(f"   🏆 Quality: {scores.quality.score}/100")
8
print(f"   📝 Grammar: {scores.grammar.score}/100")
9
print(f"   📏 Style Guide: {scores.style_guide.score}/100")
10
print(f"   🎯 Tone: {scores.tone.score}/100")
11
print(f"   📚 Terminology: {scores.terminology.score}/100")
12
13
if final_result.issues:
14
    issues = final_result.issues
15
    print(f"\n🔧 Issues Found: {len(issues)}")
16
17
    if len(issues) > 0:
18
        print("\nTop 10 Issues:")
19
        print("issue - suggestion - category")
20
        print("=" * 60)
21
        for i, issue in enumerate(issues[:10]):
22
            print(f"{i+1}. \"{issue.original}\" → \"{issue.suggestion}\" - {issue.category}")
23
    
24
    print(f"\n📊 Analysis Status: {final_result.status}")
25
    print(f"📊 Workflow ID: {workflow_id}")