Docs
Getting Started

Getting Started

Hello folks, we welcome you to Unbody. Let's get started with the basics.

play

Here are simple steps to get you started to use Unbody.

Start with the dashboard

You can access your Unbody Dashboard here (opens in a new tab). You need to sing-in/sing-up to get started.

Create a Project

Your project on Unbody is the workspace that allows you to maintain and manage your content sources. You can create your first project directly from the dashboard. When you create a project, you will be asked to configure the following:

  • Project Name: Give a name to your project.
  • Vectorization Model: Choose the model that best suits your content. You can read more about this on our Vectorization Models page.
  • AI functionalities: You can enable/disable as well as configure AI engine for different functionalities like generative Q&A, Geneartive Search, etc.

Connect Your Content Sources

Once you have set up your project, you can connect your content sources (e.g; Google Drive or Discord). You can add a source by following the steps given below.

Select a provider

Choose the platform where you have stored your content. For example, if your content is stored in Google Drive, choose it as the content provider. You can visit providers for more information.

Authorize Unbody

You must allow Unbody to access your content from the selected provider. Please read more about this on our privacy page (opens in a new tab).

Set an entry point

In this step, you need to specify where Unbody should start indexing your content. For example, you can specify a folder or an agenda.

Initialize Your Content

Now you can navigate to the source page and click “initialize”. Unbody will index the content from your entry point. Once the process is completed, the dashboard will display the number of records processed.

Please note that the time taken to index your content depends on the size of your content. You can only start interacting with your content once the indexing process is completed.

Next Steps

Once the source is initialized, you will see the status of the source as "idle". In order to interact with your content. You have a few options as given below:

Explore the GraphQL Playground

You can directly jump to the GraphQL Playground and get your hands dirty, craft your queries, and watch the magic. You can find the GraphQL Playground as middle tab in the top navigation bar on project page. We have given some tailored examples for Google Drive content.

With the query given below, you can retrieve the name and text content from a Google Doc.

query {
Get {
  GoogleDoc {
    originalName
    text
  }
}
}

Use the API directly or with SDKs

In order to be able to interact with the API directly, you first need to obtain an API key. You can find the API key in the project settings / developer settings. You can use the API key to authenticate your requests. You can read more about this on our Authorization page.

few examples to get you started

  • Retrieve Media Blocks

To access URLs and attributes for ImageBlocks and AudioFiles, you can use the query given below.

    query {
        Get {
            ImageBlock {
                url
                alt
                width
            }
            AudioFile {
                url
                size
                ext
            }
        }
    }
  • Semantic Search

You can perform the search operation using the query given below. For example, the query discovers TextBlocks conceptually related to "fashion".

query {
    Get {
        TextBlock(nearText: {concepts: ["fashion"]}) {
            text
        }
    }
}
  • Advanced Q&A

The query given below helps you extract a specific answer from a Google Doc.

query {
    Get {
        GoogleDoc(
            ask: {question: "What is Unbody's core feature?", properties: "text"}
        ) {
            _additional {
                answer {
                    result
                }
            }
        }
    }
}

Tailoring Your Queries:

These examples should help you get started, but please remember that Unbody is incredibly flexible. You can explore, experiment, and tailor your own queries to suit your unique content and needs. For more in-depth information, you can visit our API Reference.

Next Steps: