Ingest content

Easily set up your knowledge base data in NLX

What's Content of a Knowledge base?

Content, in its simplest form, refers to the knowledge base data that your conversational AI draws from to deliver a helpful response when a user's query is matched.

When properly set up, your conversational application retrieves your Knowledge base content during conversation and locates the closest semantic match to power the answer. This process is triggered when a user's utterance is otherwise unmatched to a flow, slot value or external value, or UI element.

Ingesting Content

When setting up your knowledge base, you may choose one of the following methods to ingest and host content:

Q&A: Content that's entered locally as question-and-answer parings and stored by NLX
Documents: File content that, once uploaded through NLX, is automatically managed for you in S3
External or Integration: Content hosted through your own custom vector store through S3 bucket hosting, or through a managed provider (e.g., Amazon Bedrock, Azure AI Search, Zendesk Sunshine, etc.)

Consider using the native NLX LLM to dynamically rephrase your content by turning on the Knowledge base's Summarize setting.

Q&A

This content implementation type supports Metadata filters during retrieval. To enable this functionality, provide Metadata schema after entering content.

Q&A allows you to provide knowledge base content in an FAQ style and stores the content locally within NLX.

To ingest knowledge base content using the Q&A method:

Select Resources from workspace menu > Choose Knowledge bases > New knowledge base
Provide a name to your Knowledge base
Select Q&A as content type > Click Create knowledge base
Upload a CSV or JSON file, or select + Add article to manually enter question-and-answer pair

Sample JSON format of a question and answer:

[
  {
    "question": {
      "text": "How are you doing?"
    },
    "responses": [
      {
        "type": "text",
        "body": "It's another great day for me."
      },
      {
        "type": "text",
        "body": "How may I help you?"
      }
    ]
  }
]

Optional
Payload: Provide a URL along with the response. Payload format: https://google.c

Click Save

After creating your Q&A content, the Publish tab makes your content live and updates with changes made since the last publish. These updates immediately become available to any application using a Q&A Knowledge base:

Click the Publish tab of your Q&A Knowledge base
Select Create your first deployment button

Optional:
Enter a description of your deployment to keep track of changes

Click Publish knowledge base

Did you know?

Publishing new versions of your Q&A Knowledge base content allows you to experience changes without needing to create a new application deployment following an initial application deployment.

Rollback version

To rollback your Q&A Knowledge base to a previous state, select Rollback next to the desired version from the Deployment column of the Publish tab.

Documents

Documents provides a simple document loader that allows you to ingest content from PDFs, images, and text files that is then stored for you and managed through NLX.

With a Documents-powered Knowledge base, the following occurs:

Converts text to vectors

The NLX embedding model transforms your uploaded documents into pieces of text that are mapped onto a high-dimensional space and given a numerical point on this space called a "vector." These vectors capture the semantic meaning of the data

Enables semantic search

When a user asks a question, the NLX system also converts the query into a vector and compares it to the document's vectors, looking for the closest match in the high-dimensional space

To ingest knowledge base content using the Documents method:

Select Resources from workspace menu > Choose Knowledge bases > New knowledge base
Provide a name to your Knowledge base
Select Documents as content type > Click Create knowledge base
Click Add documents > Drop files or select to browse locally from your computer
Click Save

Once uploaded files are done processing, the status column will display an Ingested status.

External

This content implementation type supports Metadata filters during retrieval. To enable this functionality, provide Metadata schema.

External allows you to establish an API connection to your knowledge base content that is externally stored through a custom data store you manage. When your conversational AI invokes the knowledge base to locate a response to an unknown user query, an API call is made to your custom service.

To ingest knowledge base content using the External format:

Select Resources from workspace menu > Choose Knowledge bases > New knowledge base
Provide a name to your Knowledge base
Select External as content type > Click Create knowledge base
Click Save

Integration

Integration allows you to establish an API connection to your knowledge base content that is externally stored through a data store service, including Amazon Bedrock, Azure AI Search, Google Vertex AI, or Zendesk Sunshine. When your conversational AI invokes the knowledge base to locate a response to an unknown user query, an API call is made to your custom service.

To ingest knowledge base content using the Integration format:

Select Resources from workspace menu > Choose Knowledge bases > New knowledge base
Provide a name to your Knowledge base
Select Integration as content type > Click Create knowledge base
Choose from a supported data store service provider already integrated in your workspace in the dropdown
Enter information into all fields (fields are unique to each provider)
Click Save

Last updated 21 days ago