https://github.com/john-carroll-sw/get-item-image
This repository demonstrates how to use OpenAI's Response API (with GPT-4.1 and tool calling) to extract the main product image URL from an e-commerce product page. It provides both Python and TypeScript implementations, returning a structured output for easy integration.
https://github.com/john-carroll-sw/get-item-image
azure-openai gpt-4 openai responses-api structured-output tool-calling url-extractor
Last synced: 4 months ago
JSON representation
This repository demonstrates how to use OpenAI's Response API (with GPT-4.1 and tool calling) to extract the main product image URL from an e-commerce product page. It provides both Python and TypeScript implementations, returning a structured output for easy integration.
- Host: GitHub
- URL: https://github.com/john-carroll-sw/get-item-image
- Owner: john-carroll-sw
- License: mit
- Created: 2025-05-29T18:09:07.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-06-10T13:27:29.000Z (4 months ago)
- Last Synced: 2025-06-10T14:42:59.958Z (4 months ago)
- Topics: azure-openai, gpt-4, openai, responses-api, structured-output, tool-calling, url-extractor
- Language: Python
- Homepage:
- Size: 25.9 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenAI Get Item Image
This repository demonstrates how to use OpenAI's Response API (with GPT-4.1 and tool calling) to extract the main product image URL from an e-commerce product page. It provides both Python and TypeScript implementations, returning a structured output for easy integration.
## Features
- Extracts the main product image URL from a given e-commerce product page.
- Uses OpenAI tool-calling to orchestrate the extraction process.
- Returns a structured response with the image URL, source URL, and extraction method.
- Supports both Python and TypeScript (Node.js) environments.
## How it Works
- The script fetches the product page HTML.
- It tries to extract the main image using Open Graph (`og:image`), a product image class, or the first image on the page.
- The result is returned in a structured format, including the extraction method used.
## Flow Diagram
```mermaid
flowchart TD
A[User provides product URL] --> B(OpenAI Response API: tool calling)
B --> C{Tool: extract_image_url}
C --> D[Fetch product page HTML]
D --> E{Extraction strategies}
E -->|og:image| F[Extract from Open Graph meta tag]
E -->|product__media| G[Extract from product__media class]
E -->|first_img| H[Extract first ![]()
tag]
F & G & H --> I[Return structured output]
I --> J[OpenAI returns structured JSON]
J --> K[User receives image_url, source_url, found_method]
```
## Example Output
```json
{
"image_url": "http://minecraftshop.com/cdn/shop/files/MINE-PLU1_R_MF_1200x1200.jpg?v=1729532536",
"source_url": "https://minecraftshop.com/collections/plush/products/minecraft-goat-8-plush",
"found_method": "og:image"
}
```
## Requirements
- Python 3.8+ (for Python version)
- Node.js 18+ (for TypeScript version)
- Access to Azure OpenAI or OpenAI API (with appropriate keys and endpoint)
## Setup
### 1. Clone the repository
```sh
git clone
cd get-item-image
```
### 2. Environment Variables
Copy `.env.sample` to `.env` and fill in your API keys and endpoints:
```sh
cp .env.sample .env
```
Edit `.env` and set:
- `AZURE_OPENAI_V1_API_ENDPOINT`
- `AZURE_OPENAI_API_KEY`
- `AZURE_OPENAI_API_MODEL`
### 3. Install Dependencies
#### Python/.py
```sh
pip install -r requirements.txt
# or manually:
pip install openai python-dotenv beautifulsoup4 requests
```
#### TypeScript/Node.js
```sh
npm install
```
## Usage
### Python
```sh
python get_item_image.py "https://minecraftshop.com/collections/plush/products/minecraft-goat-8-plush"
```
### TypeScript
```sh
npx ts-node get_item_image.ts "https://minecraftshop.com/collections/plush/products/minecraft-goat-8-plush"
```
## File Overview
- `get_item_image.py` — Python implementation
- `get_item_image.ts` — TypeScript/Node.js implementation
- `.env.sample` — Example environment variable file
- `demo.gif` — Demo animation
## License
MIT