Get Similarity Results

Once you are done running a similarity task, you can use this route to get the results.

API information for get-similarity-results endpoint:

import requests
url = "https://app.pumice.ai/api/get-similarity-results
params = {"task_id":83, "page_no":1, "n_similar_products":1}
headers = {'KEY': '<YOUR_API_KEY>'}
response = requests.request("GET", url, headers=headers, params=params)
print(response.json())

Route

https://app.pumice.ai/api/get-similarity-results

Return

This endpoint returns the similar products found in the embeddings CSV for the products in the target CSV.

A similarity score is also returned.

{
    "Product 1 Title": "Terra by Battat – 4 Dinosaur Toys, Medium – Dinosaurs for Kids & Collectors, Scientifically Accurate & Designed by A Paleo-Artist; Age 3+ (4 Pc)",
    "Product 1 Description": "Make sure this fits by entering your model number. | 4 medium-sized dinosaurs for kids, with lifelike pose, accurate ratio, and exquisitely detailed paint | Includes: Parasaurolophus walkeri, Stegosaurus ungulatus, Pachyrhinosaurus, and euoplocephalus tutus toy dinos | Museum Quality: classic toy dinosaurs designed by an internationally renowned paleo-artist | Educational toy: dinosaur toys for kids spark curiosity about paleontology, science, and natural History | Dimensions: Dimensions: miniature figurines measure 6.25-8.5 (L) 1.5-2.25 (W) 2.25-3.5 (H) inches approximately toys 6.25-8.5 (L) 1.5-2.25 (W) 2.25-3.5 (H) inches approximately | No batteries required, just imagination! | Earth-friendly recyclable packaging | Age: suggested for ages 3+ | Collect them all! Discover the entire Terra by Battat family of animal toy figurines and dinosaur playsets!",
    "Product 2 Title": "Schylling Veterinarian Kit",
    "Product 2 Description": "For the animal lover in the family, a complete veterinarian kit; perfect for the aspiring vet   Contains everything you need, 8 specialist veterinarian tools, Clipboard, and 2 special x-ray cards that you can see through when held up to the light   A great STEM/ steam toy, learn about animals and their health needs, Features dogs, cats, rabbits, horses and a pot-bellied pig   Comes in a portable “doctors” bag that holds everything in special trays; secures with a clasp and has a fold down handle   An excellent gift for boys and girls ages 3+",
    "Similarity Score": 0.4
}

n_similar_products

Integer value that lets you control how many top similar products to return for each product record in the target CSV. Default value is 1.

Type: int