Skip to main content

​
Overview

Our customers entrust us with their content, and in order to then gain a real business benefit from their content, they want to provide selective, context-aware access to it to their customers, depending on their needs. Search is how we help customers present their data, based on the context their customers provide, in the form of a query. That’s the beauty of AI-based, near-text, semantic search, and that’s why we use it at Gloo. For example, if one of our customers adds articles and podcasts about keeping a marriage strong, and during one of the podcast episodes, the discussion focuses on the guest’s top five rules for keeping a marriage healthy, we will likely want search queries that ask for “secrets to a happy marriage” to include in that particular podcast in the results. The word “secret” doesn’t necessarily have to be included in the content, and the word “rule” doesn’t have to be in the search query, but nevertheless, the results should include this podcast episode.

​
Why use Search?

Specifically, search allows you to query your ingested content, to see what you’re presenting to the world, through Gloo AI. Our API returns your content, broken up into snippets, showing what we provide to our internal chat-based tools, and what you can use in your own applications. Snippets are sections of a content item, e.g. podcast episode, article, book, that represent a large enough piece of meaningful information to be searchable, and understandable by our AI tools. These snippets also represent a recorded unit of searchable content within our backend systems.

​
RAG - Retrieval Augmented Generation

When constructing an AI application, it is sometimes useful to provide additional context to the AI model. Retrieval Augmented Generation allows you to insert these search results in the message to the model, and this can provide a more successful, context-aware interaction with your customers.

​
Making Requests

​
Prerequisites

Before making a request, you must know which publisher’s content you would like to query.
  1. Find Your Tenant (Publisher Name): First, navigate to the Organizations page in Studio and click “View Publishers”. Your Tenant is the name of the publisher you’re querying.
  2. Identify the Collection: A collection is where we keep the content for our customers. The only collection you’ll need to specify in requests is GlooProd. You must specify this in the collection field.
NOTE: You will only have access to your own publisher’s tenant through this endpoint, and a tenant must be specified. Other requests will result in a 403 “Forbidden” response.

​
How many records can I retrieve?

We recommend anywhere from 10 to 100 results, though request time will rise non-linearly with larger result sets. The limit field is how you specify how many records to return.

​
How do I make a request?

Once you have your tenant name, you’re ready to query the search endpoint. You can acquire an API key by visiting the API Credentials page and following those instructions to generate a token using the OAuth2 Client Credentials flow. Endpoint: POST /v1/kallm/search

​
Example cURL Request

cURL
curl 'https://platform.ai.gloo.com/ai/v1/kallm/search' -v \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -d '{"search":"How can I become a better parent?","collection":"GlooProd","tenant": "TestOrg", "limit":1}'
Example Response The result should look something like this:
JSON
{
  "data": [
    {
      "uuid": "12345678-abcd-1234-abcd-1234567890ab",
      "metadata": {
        "creation_time": "2025-03-13T19:55:35.287000Z",
        "last_update_time": "2025-03-13T19:55:35.287000Z",
        "distance": 0.8040247559547424,
        "certainty": 0.5979876518249512,
        "score": 0.0,
        "explain_score": "",
        "is_consistent": false,
        "rerank_score": null
      },
      "properties": {
        "ai_image_prompt": null,
        "organizationId": null,
        "publisher": "TestOrg",
        "ai_meta_description": null,
        "ai_profile_alignment": null,
        "ai_famous_quotes": null,
        "h3_number": "",
        "h2_url": "",
        "ai_audio_snippet": null,
        "tenant": "TestOrg",
        "ai_ad_placement_opportunity": null,
        "publisher_id": "",
        "producer_id": "",
        "h2_title": "",
        "evergreen": true,
        "ai_user_retention_tip": null,
        "publisherId": null,
        "ai_emotional_resonance": null,
        "summaries": {
          "ai_creative": "In a sea of gods, Yahweh shines distinctively. By boldly speaking His name, we invite the world to witness the covenant love that binds Him to us, revealing His unique character.",
          "ai_simple": "Yahweh is our God, and we should say His name so people know He is different from other gods.",
          "ai_first_grader": "Yahweh is our special God! We should say His name so everyone knows He is different from all the other gods.",
          "ai_biblical": "Worshiping Yahweh sets Him apart from all other gods. By speaking His name, we acknowledge His unique covenant with His people, inviting others to recognize His true nature.",
          "ai_news_anchor": "In today's discussion, we explore the significance of worshiping Yahweh and how speaking His name distinguishes Him from other gods.",
          "ai_phd_student": "This text emphasizes the necessity of invoking Yahweh's name to illustrate His uniqueness relative to other deities, highlighting the intimate covenantal relationship He maintains with His people.",
          "ai_formal": "It is imperative to articulate the name of Yahweh to delineate Him from other deities, thus acknowledging the intimate covenant relationship He has established with His followers.",
          "ai_elegant": "To distinguish Yahweh from other deities, we must articulate His name. This invocation not only honors our covenant with Him but also reveals His profound relationship with humanity.",
          "ai_loving": "Yahweh is our loving God, different from others. By saying His name, we can share His special promise with everyone!",
          "ai_casual": "We need to show everyone that Yahweh is totally different from other gods. Let's talk about Him by name and share how He's bound to us in a special way!"
        },
        "publisher_hierarchy_bw": "",
        "time_end": "",
        "publisher_bw": "",
        "duration": "",
        "ai_search_engine_tags": null,
        "ai_sharing_message": null,
        "isbn": "",
        "item_extra": "",
        "biblical_analysis": {
          "ai_bible_characters": [],
          "ai_book_of_the_bible": "Exodus",
          "ai_bible_references": [
            "Exodus 3:14",
            "Deuteronomy 6:4-5",
            "Isaiah 44:6"
          ],
          "ai_bible_concepts": [
            "Covenant Relationship",
            "Worship",
            "Divine Distinction"
          ],
          "ai_biblical_lesson": "The importance of recognizing and proclaiming the unique name of God, Yahweh, fosters a deeper understanding of His covenant relationship with His people.",
          "ai_biblical_concepts": [
            "Yahweh",
            "Covenant",
            "Worship",
            "Divine Name"
          ],
          "ai_bible_verses": [],
          "ai_bible_phrases": [
            "the God of Israel",
            "worship Yahweh"
          ]
        },
        "ai_terminology_definitions": null,
        "ai_conversion_potential": null,
        "ai_reading_duration": null,
        "pages": "",
        "ai_comment_prompt": null,
        "h3_id": "",
        "ai_traffic_prediction": null,
        "item_number": "",
        "denomination": "",
        "ai_engagement_score": null,
        "organization": "",
        "publication_date": "",
        "ai_mood_board": null,
        "ad_placement_opportunity": null,
        "hosted_url": "",
        "ai_reader_motivation": null,
        "ai_music_recommendation": null,
        "ai_key_statistics": null,
        "h3_extra": "",
        "ai_read_more_suggestion": null,
        "ai_meta_keywords": null,
        "h3_image": "",
        "h2_image": "",
        "ai_reader_takeaway": null,
        "drm": [],
        "item_subtitle": "",
        "engagement_score": null,
        "ai_quiz_question": null,
        "item_id": "abcdef12-3456-7890-abcd-1234567890ab",
        "snippet": "a way that would make everyone around realize that the God of Israel is very, very different from the gods of the nations. And that is exactly what we need again. We don't worship Oprah's 'god,' or Allah, or Jehovah (as in the god of the Jehovah's Witnesses). We worship Yahweh. Distinguishing him with our speech, using his name, will give us opportunity to speak of him in a way that doesn't presume others know who we're talking about. Our God, the covenant-relational God, has intimately bound himself to his people and made himself known by name. Why would we not speak his name? 1. Kindle edition, location 156. ? 2. Kindle edition, location 164. ?",
        "h2_number": "",
        "publisher_hierarchy_logo": "",
        "h2_summary": "",
        "ai_user_activity": null,
        "publisher_url": "",
        "item_title": "",
        "ai_topic_classification": null,
        "ai_user_interests": null,
        "organization_id": "",
        "filename": "example_text_file_12345",
        "publisher_fav": "",
        "ai_title_variations": null,
        "h3_summary": "",
        "h2_file": "",
        "ai_reader_impact": null,
        "h3_file": "",
        "ai_feedback_request": null,
        "publisher_logo": "",
        "type": "",
        "h2_extra": "",
        "publisher_hierarchy": "",
        "item_url": "",
        "screen_cap": "",
        "ai_search_snippet": null,
        "traffic_prediction": null,
        "item_summary": "",
        "time_start": "",
        "ai_sharing_probability": null,
        "h2_id": "",
        "part": 4,
        "conversion_potential": null,
        "item_file": "",
        "h3_subtitle": "",
        "ai_song_lyric": null,
        "ai_interactive_callout": null,
        "h2_subtitle": "",
        "ai_poll_question": null,
        "ai_content_clusters": null,
        "ai_tweet": null,
        "h3_title": "",
        "analysis": null,
        "ai_scripture_parallels": null,
        "pub_type": "",
        "item_tags": [],
        "general_analysis": {
          "ai_why_matter": "Understanding the distinctiveness of Yahweh enriches one's faith journey and deepens the relational aspect of worship, fostering a true sense of belonging and identity in a complex world.",
          "ai_image_prompt": "An artistic representation of the name 'Yahweh' surrounded by symbols of different faiths, emphasizing the uniqueness and identity of the God of Israel.",
          "ai_meta_description": "Discover the significance of worshiping Yahweh and the importance of invoking His name to distinguish Him from other deities.",
          "ai_thriving": [
            "Worship Experience",
            "Bible-Centeredness",
            "Spiritual Formation"
          ],
          "ai_describing_words": [
            "Distinct",
            "Covenantal",
            "Intimate"
          ],
          "ai_profile_alignment": [
            "Faith-based communities",
            "Religious scholars",
            "Cultural interfaith dialogue"
          ],
          "ai_why_bullets": [
            "Reinforces the uniqueness of God",
            "Encourages personal relationship with Yahweh",
            "Promotes clarity in worship practices"
          ],
          "ai_hashtags": [
            "#Yahweh",
            "#Worship",
            "#Covenant"
          ],
          "ai_books_mentioned": [],
          "ai_famous_quotes": [],
          "ai_important_phrase": "We worship Yahweh.",
          "ai_standalone": "high",
          "ai_audio_snippet": "Join us as we discuss the importance of speaking Yahweh's name and understanding His unique covenant with us.",
          "ai_ad_placement_opportunity": "This text is suitable for ads related to religious books or worship events.",
          "ai_flourishing": [
            "Faith"
          ],
          "ai_user_activity": "Engage in a discussion about the significance of names in faith traditions.",
          "ai_user_retention_tip": "Encourage readers to share their experiences and reflections on the name of Yahweh to foster community engagement.",
          "ai_emotional_resonance": [
            "Reverence",
            "Identity",
            "Connection"
          ],
          "ai_topic_classification": "Theology",
          "ai_keywords": [
            "Yahweh",
            "Worship",
            "Covenant"
          ],
          "ai_user_interests": [
            "Religious Studies",
            "Theology",
            "Worship Practices"
          ],
          "ai_christian_topics": [
            "Theology",
            "Worship",
            "Covenant Relationships"
          ],
          "ai_title_variations": [
            "Worshiping Yahweh: A Distinctive Journey",
            "Understanding the Name of God",
            "Yahweh: The God Who Binds Us"
          ],
          "ai_reader_impact": "This text encourages reflection on personal faith and may inspire a renewed commitment to worship.",
          "ai_feedback_request": "What are your thoughts on the importance of God's name in your faith?",
          "ai_sentiment": "Positive",
          "ai_complexity": 8.2,
          "ai_search_engine_tags": [
            "Yahweh",
            "Covenant God",
            "Worship Differences"
          ],
          "ai_sharing_message": "Explore the unique nature of Yahweh and how His name transforms our worship experience!",
          "ai_famous_people": [
            "Oprah"
          ],
          "ai_conversion_potential": "High, as it encourages readers to explore more about their faith and worship practices.",
          "ai_readability": 12.5,
          "ai_search_snippet": "Explore the distinctiveness of Yahweh, the God of Israel, and how speaking His name can deepen your understanding of faith.",
          "ai_life_issues": [
            "Understanding Faith",
            "Religious Identity",
            "Cultural Differences"
          ],
          "ai_terminology_definitions": [
            "Covenant: A solemn agreement between God and His people, signifying a committed relationship."
          ],
          "ai_subtitle": "Understanding Our Covenant God",
          "ai_reading_duration": 2.0,
          "ai_social_media_caption": "Discover how proclaiming Yahweh's name can transform our understanding of worship and identity!",
          "ai_sharing_probability": 7.0,
          "ai_comment_prompt": "What does Yahweh mean to you in your faith journey?",
          "ai_profile_gender": "Not targeted to a specific gender",
          "ai_traffic_prediction": 1500.0,
          "ai_intent": "Informs",
          "ai_song_lyric": "In the name of Yahweh, we find our way.",
          "ai_interactive_callout": "Click here to learn more about the significance of Yahweh's name!",
          "ai_engagement_score": 8.0,
          "ai_poll_question": "What name do you prefer to use for God?",
          "ai_content_clusters": [
            "Theology",
            "Worship",
            "Faith Practices"
          ],
          "ai_title": "The Uniqueness of Yahweh",
          "ai_mood_board": "A mood board featuring religious symbols, images of worship, and representations of community, focusing on the themes of faith and divine relationship.",
          "ai_google_search": [
            "Yahweh worship",
            "Difference between Yahweh and other gods",
            "Covenant relationship with God"
          ],
          "ai_scripture_parallels": [
            "Exodus 20:7",
            "Isaiah 52:6"
          ],
          "ai_tweet": "Why is Yahweh different? Let's explore the significance of His name and covenant with us! #Yahweh #Worship",
          "ai_next_steps": [
            "Exploring personal faith journeys",
            "Engaging in discussions about religious identity",
            "Practicing open conversations about God"
          ],
          "ai_reader_motivation": "Readers seeking to understand their faith and the uniqueness of their worship will find this text engaging.",
          "ai_music_recommendation": "Gospel music that celebrates the name of God.",
          "ai_key_statistics": [],
          "ai_personas": [
            "Theologians",
            "Church Leaders",
            "Faith Seekers"
          ],
          "ai_read_more_suggestion": [
            "Books on the Names of God",
            "Studies on Covenant Theology",
            "Articles on Interfaith Comparisons"
          ],
          "ai_meta_keywords": [
            "Yahweh",
            "Worship",
            "Covenant"
          ],
          "ai_questions_answered": [
            "Why should we speak the name of God?",
            "What makes Yahweh different from other gods?",
            "How does God relate to His people?"
          ],
          "ai_quiz_question": "What is the significance of invoking the name Yahweh in worship?",
          "ai_reader_takeaway": "The name of Yahweh holds profound significance and invites a deeper relationship with God."
        },
        "publisher_hierarchy_url": "",
        "h3_url": "",
        "ai_personas": null,
        "publisher_hierarchy_fav": "",
        "start_index": 3015,
        "item_image": "",
        "author": [],
        "sharing_probability": null
      },
      "references": null,
      "vector": {},
      "collection": "GlooProd"
    }
  ],
  "intent": 1
}
⌘I