Get Verbose Item Recommendations

POST

data

items

recommendations

verbose

Get Verbose Item Recommendations

curl --request POST \
  --url https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection": "GlooProd",
  "max_snippet_count_overall": 10,
  "media_types": [],
  "min_snippet_count_per_item": 1,
  "publishers": [
    "Test New Tenant"
  ],
  "query": "Plans God has for me",
  "tenant": "TestNewTenant",
  "certainty_threshold": 0.5,
  "item_count": 3,
  "item_extra_contains": [
    "visibleOnApps:true"
  ],
  "sort_by": "publication_date",
  "sort_order": "desc"
}
'

import requests

url = "https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose"

payload = {
    "collection": "GlooProd",
    "max_snippet_count_overall": 10,
    "media_types": [],
    "min_snippet_count_per_item": 1,
    "publishers": ["Test New Tenant"],
    "query": "Plans God has for me",
    "tenant": "TestNewTenant",
    "certainty_threshold": 0.5,
    "item_count": 3,
    "item_extra_contains": ["visibleOnApps:true"],
    "sort_by": "publication_date",
    "sort_order": "desc"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    collection: 'GlooProd',
    max_snippet_count_overall: 10,
    media_types: [],
    min_snippet_count_per_item: 1,
    publishers: ['Test New Tenant'],
    query: 'Plans God has for me',
    tenant: 'TestNewTenant',
    certainty_threshold: 0.5,
    item_count: 3,
    item_extra_contains: ['visibleOnApps:true'],
    sort_by: 'publication_date',
    sort_order: 'desc'
  })
};

fetch('https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'collection' => 'GlooProd',
    'max_snippet_count_overall' => 10,
    'media_types' => [
        
    ],
    'min_snippet_count_per_item' => 1,
    'publishers' => [
        'Test New Tenant'
    ],
    'query' => 'Plans God has for me',
    'tenant' => 'TestNewTenant',
    'certainty_threshold' => 0.5,
    'item_count' => 3,
    'item_extra_contains' => [
        'visibleOnApps:true'
    ],
    'sort_by' => 'publication_date',
    'sort_order' => 'desc'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose"

	payload := strings.NewReader("{\n  \"collection\": \"GlooProd\",\n  \"max_snippet_count_overall\": 10,\n  \"media_types\": [],\n  \"min_snippet_count_per_item\": 1,\n  \"publishers\": [\n    \"Test New Tenant\"\n  ],\n  \"query\": \"Plans God has for me\",\n  \"tenant\": \"TestNewTenant\",\n  \"certainty_threshold\": 0.5,\n  \"item_count\": 3,\n  \"item_extra_contains\": [\n    \"visibleOnApps:true\"\n  ],\n  \"sort_by\": \"publication_date\",\n  \"sort_order\": \"desc\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"collection\": \"GlooProd\",\n  \"max_snippet_count_overall\": 10,\n  \"media_types\": [],\n  \"min_snippet_count_per_item\": 1,\n  \"publishers\": [\n    \"Test New Tenant\"\n  ],\n  \"query\": \"Plans God has for me\",\n  \"tenant\": \"TestNewTenant\",\n  \"certainty_threshold\": 0.5,\n  \"item_count\": 3,\n  \"item_extra_contains\": [\n    \"visibleOnApps:true\"\n  ],\n  \"sort_by\": \"publication_date\",\n  \"sort_order\": \"desc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"collection\": \"GlooProd\",\n  \"max_snippet_count_overall\": 10,\n  \"media_types\": [],\n  \"min_snippet_count_per_item\": 1,\n  \"publishers\": [\n    \"Test New Tenant\"\n  ],\n  \"query\": \"Plans God has for me\",\n  \"tenant\": \"TestNewTenant\",\n  \"certainty_threshold\": 0.5,\n  \"item_count\": 3,\n  \"item_extra_contains\": [\n    \"visibleOnApps:true\"\n  ],\n  \"sort_by\": \"publication_date\",\n  \"sort_order\": \"desc\"\n}"

response = http.request(request)
puts response.read_body

[
  {
    "item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "author": [
      "<string>"
    ],
    "filename": "<string>",
    "tradition": "<string>",
    "duration": "<string>",
    "item_title": "<string>",
    "item_subtitle": "<string>",
    "item_image": "<string>",
    "item_url": "<string>",
    "item_tags": "<string>",
    "h2_id": "<string>",
    "h2_title": "<string>",
    "h2_subtitle": "<string>",
    "h2_image": "<string>",
    "h2_url": "<string>",
    "h2_tags": "<string>",
    "h3_id": "<string>",
    "h3_title": "<string>",
    "h3_subtitle": "<string>",
    "h3_image": "<string>",
    "h3_url": "<string>",
    "h3_tags": "<string>",
    "h2_summary": "<string>",
    "publication_date": "<string>",
    "publisher": "<string>",
    "publisher_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publisher_url": "<string>",
    "publisher_logo": "<string>",
    "item_summary": "<string>",
    "type": "<string>",
    "hosted_url": "<string>",
    "snippet_count": 123,
    "cumulative_certainty": 123,
    "denomination": "<string>",
    "uuids": [
      {
        "uuid": "<string>",
        "ai_title": "<string>",
        "ai_subtitle": "<string>",
        "item_summary": "<string>",
        "time_start": "<string>",
        "time_end": "<string>",
        "part": 123,
        "certainty": 123,
        "snippet": "<string>"
      }
    ],
    "item_extra": "<string>"
  }
]

Error Reference: Search & Recommendations

Common errors: invalid collection, missing or invalid tenant, certainty threshold issues, empty query string.

Authorizations

Authorization

string

header

default:<api-key>

required

Bearer authentication header of the form Bearer <api-key>, where <api-key> is your API key.

Body

application/json

Parameters for retrieving verbose item recommendations.

query

string

required

The prompt that the user enters into the application.

Minimum string length: 1

collection

string

required

The collection to search in.

Minimum string length: 1

certainty_threshold

number

default:0.5

The minimum certainty threshold for snippets.

Required range: 0 <= x <= 1

tenant

string

Optional tenant to search. Required only when the selected collection is multi-tenant; invalid when the selected collection is not multi-tenant. Blank strings are normalized to no tenant.

publishers

string[]

A list of Publisher Names. Only publishers belonging to your organization are allowed.

Minimum string length: 1

max_snippet_count_overall

integer

default:10

The maximum number of snippets to search through overall.

Required range: x >= 1

min_snippet_count_per_item

integer

default:1

The minimum number of snippets for an item to be returned.

Required range: x >= 1

media_types

enum<string>[]

The type(s) of media for the items returned.

Available options:

audio,

video,

book,

article

item_count

integer

The maximum number of items to return. Items are ranked by cumulative certainty. If the available snippets span fewer items than this count, only those items are returned.

Required range: x >= 1

item_extra_contains

string[]

Case-sensitive substring filters matched against each item's raw item_extra text. All entries must match (AND) for an item to be returned. Filtering is applied server-side, so paging operates on the filtered set. The wildcard characters * and ? are not permitted and return a 422 response.

Example:

["visibleOnApps:true"]

sort_by

enum<string>

default:relevance

The ordering applied to returned items. relevance ranks by cumulative certainty; publication_date orders by each item's best-effort parsed publication date, with items whose date is empty or unparseable always sorted last. publish_date is accepted as an alias for publication_date.

Available options:

relevance,

publication_date

sort_order

enum<string>

default:desc

The sort direction, applied only when sort_by is publication_date. desc returns newest items first; asc returns oldest first.

Available options:

asc,

desc

Response

Successful response returning a list of items with full snippet text.

item_id

string<uuid>

author

string[]

filename

string

tradition

string

duration

string

item_title

string

item_subtitle

string

item_image

string<uri>

item_url

string<uri>

item_tags

h2_id

string

h2_title

string

h2_subtitle

string

h2_image

string<uri>

h2_url

string<uri>

h2_tags

string | null

h3_id

string

h3_title

string

h3_subtitle

string

h3_image

string<uri>

h3_url

string<uri>

h3_tags

string | null

h2_summary

string

publication_date

string

publisher

string

publisher_id

string<uuid>

publisher_url

string<uri>

publisher_logo

string<uri>

item_summary

string

type

string

hosted_url

string<uri>

snippet_count

integer

cumulative_certainty

number<float>

denomination

string

uuids

ItemRecommendationUuidVerbose · object[]

Show child attributes

item_extra

string

The item's raw item_extra text. May be an empty string.

⌘I

Get Verbose Item Recommendations

curl --request POST \
  --url https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection": "GlooProd",
  "max_snippet_count_overall": 10,
  "media_types": [],
  "min_snippet_count_per_item": 1,
  "publishers": [
    "Test New Tenant"
  ],
  "query": "Plans God has for me",
  "tenant": "TestNewTenant",
  "certainty_threshold": 0.5,
  "item_count": 3,
  "item_extra_contains": [
    "visibleOnApps:true"
  ],
  "sort_by": "publication_date",
  "sort_order": "desc"
}
'

import requests

url = "https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose"

payload = {
    "collection": "GlooProd",
    "max_snippet_count_overall": 10,
    "media_types": [],
    "min_snippet_count_per_item": 1,
    "publishers": ["Test New Tenant"],
    "query": "Plans God has for me",
    "tenant": "TestNewTenant",
    "certainty_threshold": 0.5,
    "item_count": 3,
    "item_extra_contains": ["visibleOnApps:true"],
    "sort_by": "publication_date",
    "sort_order": "desc"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    collection: 'GlooProd',
    max_snippet_count_overall: 10,
    media_types: [],
    min_snippet_count_per_item: 1,
    publishers: ['Test New Tenant'],
    query: 'Plans God has for me',
    tenant: 'TestNewTenant',
    certainty_threshold: 0.5,
    item_count: 3,
    item_extra_contains: ['visibleOnApps:true'],
    sort_by: 'publication_date',
    sort_order: 'desc'
  })
};

fetch('https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'collection' => 'GlooProd',
    'max_snippet_count_overall' => 10,
    'media_types' => [
        
    ],
    'min_snippet_count_per_item' => 1,
    'publishers' => [
        'Test New Tenant'
    ],
    'query' => 'Plans God has for me',
    'tenant' => 'TestNewTenant',
    'certainty_threshold' => 0.5,
    'item_count' => 3,
    'item_extra_contains' => [
        'visibleOnApps:true'
    ],
    'sort_by' => 'publication_date',
    'sort_order' => 'desc'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose"

	payload := strings.NewReader("{\n  \"collection\": \"GlooProd\",\n  \"max_snippet_count_overall\": 10,\n  \"media_types\": [],\n  \"min_snippet_count_per_item\": 1,\n  \"publishers\": [\n    \"Test New Tenant\"\n  ],\n  \"query\": \"Plans God has for me\",\n  \"tenant\": \"TestNewTenant\",\n  \"certainty_threshold\": 0.5,\n  \"item_count\": 3,\n  \"item_extra_contains\": [\n    \"visibleOnApps:true\"\n  ],\n  \"sort_by\": \"publication_date\",\n  \"sort_order\": \"desc\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"collection\": \"GlooProd\",\n  \"max_snippet_count_overall\": 10,\n  \"media_types\": [],\n  \"min_snippet_count_per_item\": 1,\n  \"publishers\": [\n    \"Test New Tenant\"\n  ],\n  \"query\": \"Plans God has for me\",\n  \"tenant\": \"TestNewTenant\",\n  \"certainty_threshold\": 0.5,\n  \"item_count\": 3,\n  \"item_extra_contains\": [\n    \"visibleOnApps:true\"\n  ],\n  \"sort_by\": \"publication_date\",\n  \"sort_order\": \"desc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.ai.gloo.com/ai/v1/data/items/recommendations/verbose")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"collection\": \"GlooProd\",\n  \"max_snippet_count_overall\": 10,\n  \"media_types\": [],\n  \"min_snippet_count_per_item\": 1,\n  \"publishers\": [\n    \"Test New Tenant\"\n  ],\n  \"query\": \"Plans God has for me\",\n  \"tenant\": \"TestNewTenant\",\n  \"certainty_threshold\": 0.5,\n  \"item_count\": 3,\n  \"item_extra_contains\": [\n    \"visibleOnApps:true\"\n  ],\n  \"sort_by\": \"publication_date\",\n  \"sort_order\": \"desc\"\n}"

response = http.request(request)
puts response.read_body

[
  {
    "item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "author": [
      "<string>"
    ],
    "filename": "<string>",
    "tradition": "<string>",
    "duration": "<string>",
    "item_title": "<string>",
    "item_subtitle": "<string>",
    "item_image": "<string>",
    "item_url": "<string>",
    "item_tags": "<string>",
    "h2_id": "<string>",
    "h2_title": "<string>",
    "h2_subtitle": "<string>",
    "h2_image": "<string>",
    "h2_url": "<string>",
    "h2_tags": "<string>",
    "h3_id": "<string>",
    "h3_title": "<string>",
    "h3_subtitle": "<string>",
    "h3_image": "<string>",
    "h3_url": "<string>",
    "h3_tags": "<string>",
    "h2_summary": "<string>",
    "publication_date": "<string>",
    "publisher": "<string>",
    "publisher_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publisher_url": "<string>",
    "publisher_logo": "<string>",
    "item_summary": "<string>",
    "type": "<string>",
    "hosted_url": "<string>",
    "snippet_count": 123,
    "cumulative_certainty": 123,
    "denomination": "<string>",
    "uuids": [
      {
        "uuid": "<string>",
        "ai_title": "<string>",
        "ai_subtitle": "<string>",
        "item_summary": "<string>",
        "time_start": "<string>",
        "time_end": "<string>",
        "part": 123,
        "certainty": 123,
        "snippet": "<string>"
      }
    ],
    "item_extra": "<string>"
  }
]

General

Models

Completions

Content

Data Engine Content Controls

Legacy / Deprecated APIs

Get Verbose Item Recommendations

Error Reference: Search & Recommendations

Authorizations

Body

Response