🔍 Code Extractor

Tests the LLM client functionality by analyzing a sample contract text and verifying the extraction of key contract metadata such as third parties, dates, and status.

Purpose

This function serves as a test harness for validating the LLMClient's contract analysis capabilities. It creates a sample contract text containing parties, dates, and status information, then invokes the LLM client to extract structured data. The function is designed for integration testing, configuration validation, and ensuring the LLM client is properly configured and operational before processing real documents.

Source Code

def test_llm_client(config):
    """Test LLM client."""
    print("\nTesting LLM client...")
    
    try:
        llm_client = LLMClient(config['llm'])
        
        test_text = """
        AGREEMENT BETWEEN ACME CORP AND BETA INC
        
        This agreement is entered into on January 15, 2024, between ACME Corporation 
        and Beta Inc. The contract period runs from February 1, 2024 to January 31, 2025.
        
        This agreement is currently active and in effect.
        """
        
        result = llm_client.analyze_contract(test_text, "test_document.pdf")
        
        print(f"✓ LLM analysis completed")
        print(f"  Third parties: {result.get('third_parties', 'N/A')}")
        print(f"  Start date: {result.get('start_date', 'N/A')}")
        print(f"  End date: {result.get('end_date', 'N/A')}")
        print(f"  In effect: {result.get('in_effect', 'N/A')}")
        
        return True
        
    except Exception as e:
        print(f"✗ LLM client failed: {e}")
        return False

Parameters

Parameter Details

config: A dictionary containing configuration settings for the LLM client. Must include an 'llm' key with nested configuration parameters such as API keys, model settings, endpoints, and other LLM-specific settings required by the LLMClient constructor.

Return Value

Returns a boolean value: True if the LLM client successfully analyzes the test contract and returns results without exceptions, False if any exception occurs during the test. The function does not return the analysis results themselves, only the success/failure status.

Dependencies

• logging
• pathlib
• utils.llm_client

Required Imports

from utils.llm_client import LLMClient

Usage Example

from utils.llm_client import LLMClient

config = {
    'llm': {
        'api_key': 'your-api-key-here',
        'model': 'gpt-4',
        'temperature': 0.0,
        'max_tokens': 2000
    }
}

success = test_llm_client(config)
if success:
    print('LLM client is working correctly')
else:
    print('LLM client test failed')

Best Practices

• Ensure the config dictionary contains all required LLM configuration parameters before calling this function
• Run this test function during application startup or configuration validation to catch LLM client issues early
• Monitor the printed output to verify that the LLM is correctly extracting contract metadata
• This function prints results to stdout; consider capturing output in automated testing environments
• The test uses a hardcoded sample contract; results may vary based on the LLM model and configuration used
• Handle the boolean return value appropriately in test suites or validation workflows
• Be aware that this function makes an actual API call to the LLM service, which may incur costs
• Consider implementing timeout handling for production use to prevent hanging on slow LLM responses

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function test_llm_extraction 83.6% similar

  A test function that validates LLM-based contract data extraction by processing a sample contract and verifying the extracted fields against expected values.

  From: /tf/active/vicechatdev/contract_validity_analyzer/test_extractor.py

• function test_new_fields 81.7% similar

  A test function that validates an LLM client's ability to extract third-party email addresses and tax identification numbers from contract documents.

  From: /tf/active/vicechatdev/contract_validity_analyzer/test_new_fields.py

• function test_with_simulated_content 72.9% similar

  Tests LLM-based contract analysis prompts using simulated NDA content containing a term clause to verify extraction of contract dates and metadata.

  From: /tf/active/vicechatdev/contract_validity_analyzer/test_local_document.py

• function test_llm_connectivity 72.9% similar

  Tests the connectivity and functionality of an OpenAI LLM integration by analyzing a mock email with vendor information extraction.

  From: /tf/active/vicechatdev/find_email/test_vendor_extractor.py

• function test_end_date_extraction 69.9% similar

  Tests end date extraction functionality for contract documents that previously had missing end dates by downloading documents from FileCloud, extracting text, analyzing with LLM, and comparing results.

  From: /tf/active/vicechatdev/contract_validity_analyzer/test_missing_end_dates.py