Skip to content

Detect addresses in text using AI - extracts and validates postal addresses

License

Notifications You must be signed in to change notification settings

sharpapi/php-content-address-detector

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SharpAPI GitHub cover

Content Address Detector API for PHP

📝 Detect addresses in text using AI - extracts and validates postal addresses

Latest Version on Packagist Total Downloads

Check the full documentation on the Content Address Detector API for PHP API page.


Quick Links

Resource Link
Main API Documentation Authorization, Webhooks, Polling & More
Product Details SharpAPI.com
SDK Libraries GitHub - SharpAPI SDKs

Requirements

  • PHP >= 8.0

Installation

Step 1. Install the package via Composer:

composer require sharpapi/php-content-address-detector

Step 2. Visit SharpAPI to get your API key.


Laravel Integration

Building a Laravel application? Check the Laravel package version for better integration.


What it does

Detect addresses in text using AI - extracts and validates postal addresses


Usage

<?php

require __DIR__ . '/vendor/autoload.php';

use SharpAPI\ContentAddress\AddressDetectorClient;
use GuzzleHttp\Exception\GuzzleException;

$apiKey = 'your_api_key_here';
$client = new AddressDetectorClient(apiKey: $apiKey);

try {
    $statusUrl = $client->detectAddress(
        content: 'Your text content here'
    );

    // Optional: Configure polling
    $client->setApiJobStatusPollingInterval(10);
    $client->setApiJobStatusPollingWait(180);

    // Fetch results (polls automatically)
    $result = $client->fetchResults($statusUrl);
    $resultData = $result->getResultJson();

    echo $resultData;
} catch (GuzzleException $e) {
    echo "API error: " . $e->getMessage();
}

Example Response

{
    "data": {
        "type": "api_job_result",
        "id": "06f4a1ba-b6b1-48b3-b071-807e3d41db4d",
        "attributes": {
            "status": "success",
            "type": "content_detect_address",
            "result": [
                "123 Main Street, Springfield, IL 62701",
                "456 Oak Avenue, Suite 200, Portland, OR 97201"
            ]
        }
    }
}

Changelog

Please see CHANGELOG for more information on what has changed recently.


Credits


License

License: MIT

The MIT License (MIT). Please see License File for more information.


Social Media

🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:

About

Detect addresses in text using AI - extracts and validates postal addresses

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages