> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gloo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Verbose Item Recommendations
> Retrieves item recommendations with detailed snippet metadata, including the full snippet text. Requires specifying a collection and tenant for the search.
Common errors: invalid collection, missing or invalid tenant, certainty threshold issues, empty query string.
## OpenAPI
````yaml post /ai/v1/data/items/recommendations/verbose
openapi: 3.1.0
info:
title: AI API
description: |-
Optimized for high-speed inference and scalability by Gloo AI
[Swagger UI](./docs) | [ReDoc UI](./redoc)
version: 1.0.0
servers:
- url: https://platform.ai.gloo.com
security:
- bearerAuth: []
tags:
- name: Content Controls
- name: Data Engine
- name: Ingestion & Enrichment
- name: answers
- name: chat
- name: completions
- name: content
- name: core
- name: data
- name: get-models
- name: ingestion
- name: sotc
paths:
/ai/v1/data/items/recommendations/verbose:
post:
tags:
- data
summary: Get Verbose Item Recommendations
description: >-
Retrieves item recommendations with detailed snippet metadata, including
the full snippet text. Requires specifying a collection and tenant for
the search.
operationId: get-verbose-item-recommendations
requestBody:
description: Parameters for retrieving verbose item recommendations.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemsRequestBody'
example:
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
responses:
'200':
description: >-
Successful response returning a list of items with full snippet
text.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemsRecommendationsResponseItemVerbose'
'400':
description: >-
Bad Request - The request was improperly formatted or contained
invalid parameters (e.g., invalid collection or tenant
configuration).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid Collection:
summary: 'Error: Invalid Collection'
value:
detail: >-
Invalid Collection. Please see
https://docs.gloo.com/api-guides/search#making-requests
for information on providing a valid collection.
Missing Tenant for Multi-Tenant Collection:
summary: 'Error: Missing Tenant'
value:
detail: >-
Unable to search multi-tenant collection, {collection}.
Please provide a valid tenant. See
https://docs.gloo.com/api-guides/search#making-requests
for information on providing a valid tenant.
Tenant in Non-Multi-Tenant Collection:
summary: 'Error: Invalid Tenant for Collection'
value:
detail: >-
Unable to search tenant, {tenant}, in non-multi-tenant
collection, {collection}. Provide a multi-tenant
collection, or remove tenant. See
/ai/v1/data/collection/names?multi_tenancy=true
Invalid Tenant for Collection:
summary: 'Error: Invalid Tenant for Given Collection'
value:
detail: >-
Unable to search tenant, {request_body.tenant}, in
collection, {request_body.collection}. Please provide a
valid tenant. See
https://docs.gloo.com/api-guides/search#making-requests
for information on providing a valid tenant.
'401':
description: Unauthorized - The JWT token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: Unauthorized
'403':
description: Forbidden - Caller is not authorized to access the requested data
content:
application/json:
schema:
additionalProperties: true
type: object
example:
detail: Forbidden
'422':
description: >-
Validation Error - The request body fails validation (e.g., missing
required fields).
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'500':
description: >-
Internal Server Error - An error occurred while searching for
sources.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
detail: Error searching sources. Our team has been notified.
security:
- bearerAuth: []
components:
schemas:
ItemsRequestBody:
type: object
title: ItemsRequestBody
properties:
query:
type: string
minLength: 1
description: The prompt that the user enters into the application.
certainty_threshold:
type: number
maximum: 1
minimum: 0
title: Certainty Threshold
description: The minimum certainty threshold for snippets.
default: 0.5
collection:
type: string
minLength: 1
description: The collection to search in.
tenant:
type: string
description: >-
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:
type: array
items:
type: string
minLength: 1
description: >-
A list of Publisher Names. Only publishers belonging to your
organization are allowed.
max_snippet_count_overall:
type: integer
description: The maximum number of snippets to search through overall.
minimum: 1
default: 10
min_snippet_count_per_item:
type: integer
description: The minimum number of snippets for an item to be returned.
minimum: 1
default: 1
media_types:
type: array
items:
type: string
enum:
- audio
- video
- book
- article
description: The type(s) of media for the items returned.
default: []
item_count:
type: integer
description: >-
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.
minimum: 1
required:
- query
- collection
ItemsRecommendationsResponseItemVerbose:
type: object
title: ItemsRecommendationsResponseItemVerbose
allOf:
- $ref: '#/components/schemas/AffiliatesItem'
properties:
uuids:
type: array
items:
$ref: '#/components/schemas/ItemRecommendationUuidVerbose'
Error:
type: object
properties:
detail:
type: string
description: A human-readable description of the error.
title: Error
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
AffiliatesItem:
type: object
title: AffiliatesItem
properties:
item_id:
type: string
format: uuid
author:
type: array
items:
type: string
filename:
type: string
tradition:
type: string
duration:
type: string
item_title:
type: string
item_subtitle:
type: string
item_image:
type: string
format: uri
item_url:
type: string
format: uri
item_tags:
anyOf:
- type: string
- type: array
items:
type: string
h2_id:
type: string
h2_title:
type: string
h2_subtitle:
type: string
h2_image:
type: string
format: uri
h2_url:
type: string
format: uri
h2_tags:
anyOf:
- type: string
- type: 'null'
h3_id:
type: string
h3_title:
type: string
h3_subtitle:
type: string
h3_image:
type: string
format: uri
h3_url:
type: string
format: uri
h3_tags:
anyOf:
- type: string
- type: 'null'
h2_summary:
type: string
publication_date:
type: string
publisher:
type: string
publisher_id:
type: string
format: uuid
publisher_url:
type: string
format: uri
publisher_logo:
type: string
format: uri
item_summary:
type: string
type:
type: string
hosted_url:
type: string
format: uri
snippet_count:
type: integer
cumulative_certainty:
type: number
format: float
denomination:
type: string
ItemRecommendationUuidVerbose:
type: object
title: ItemRecommendationUuidVerbose
allOf:
- $ref: '#/components/schemas/ItemRecommendationUuidBase'
properties:
snippet:
type: string
description: The full text of the snippet.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
ItemRecommendationUuidBase:
type: object
title: ItemRecommendationUuidBase
properties:
uuid:
type: string
ai_title:
type: string
ai_subtitle:
type: string
item_summary:
type: string
time_start:
type: string
time_end:
type: string
part:
type: integer
certainty:
type: number
format: float
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Bearer authentication header of the form Bearer ``, where
`` is your [auth token](/studio/manage-api-credentials).
````