Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Recommendations and Pathways Visual search API

3 actions 3 updates phrasing extends openapi/bloomreach-visual-search-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Bloomreach's API. It is a proposal applied on top of the contract, not a document Bloomreach publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/visual/upload/{widget_id}'].post

$.paths['/visual/search/{widget_id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Recommendations and Pathways Visual search API
  version: 1.0.0
extends: openapi/bloomreach-visual-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/visual/upload/{widget_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image for visual search
      effect: write
      questions:
      - How do I upload a shopper's photo so I can find visually similar products?
      - Which image formats can I send to the visual search upload?
      - What do I get back after uploading an image that I need for the search step?
      instructions:
      - text: Upload this image to visual search widget {widget_id}.
        slots:
          widget_id: path.widget_id
      - text: Upload the photo as a {Content-Type} file to widget {widget_id} for account {account_id}.
        slots:
          Content-Type: header.Content-Type
          widget_id: path.widget_id
          account_id: query.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/visual/search/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find products that look like an image
      effect: read
      questions:
      - Can I get products that look similar to a picture a shopper already uploaded?
      - Is there a way to get visually similar items for a product already in my catalog?
      - Can visual results focus on just one detected object in the image rather than the whole picture?
      instructions:
      - text: Run visual search on widget {widget_id} for uploaded image {image_id}.
        slots:
          widget_id: path.widget_id
          image_id: query.image_id
      - text: Find items that look like product {item_ids} using visual widget {widget_id}.
        slots:
          item_ids: query.item_ids
          widget_id: path.widget_id
      - text: Show look-alike products for object {object_id} in image {image_id} via widget {widget_id}.
        slots:
          object_id: query.object_id
          image_id: query.image_id
          widget_id: path.widget_id
      method: generated
      generated: '2026-09-26'