​

Quick Start

subscription StartNewChat {
  newSessionChatResult(
    input: {
      messageInput: "How do I get started?"
      organizationId: "<YOUR_ORG_ID>"
      integrationId: "<YOUR_INTEGRATION_ID>"
    }
  ) {
    message {
      content
      id
      citations {
        title
        url
        citationNumber
      }
    }
    sessionId
  }
}

The newSessionChatResult subscription is used to create a new chat and receive a subscription event every time there is a new update to the chat response. With this subscription, you can stream responses, provide citations, and get run-time analytics of the user chat using websockets.

Try the API Playground for an interactive way to use the newSessionChatResult API.

​

Reference

​

newSessionChatResult

​

Input Types

​

NewSessionChatResultInput

​

ChatFiltersInput

When we ingest content, we add metadata to the content that is filterable in our search and chat APIs. For example, if you have multiple products or version your product, you can “scope” the chat session if you know the product or product version that the user is interested in.

This might be based on:

• the URL the user is viewing
• a product or version picker in your docs or chat UX
• in-app context you have about the user, like which products or versions they use

By default, we label source documents with a product and product version if it can be inferred from your HTML or URL structure.

If you use our ingestion APIs, you can add your own ‘attributes’ that are filterable to the source documents and create your own filter queries based on that.

​

Filter attributes

Our attributes filtering schema is based on MongoDB’s query and projection operators. We currently support $in, $not, $and and $or operators or conditions.

The attributes value should be valid within this schema. See an example below

{
  "attributes": {
    "$and": [
      { "env": "production" },
      { "modules": { "$in": ["module1", "module2"] } }
    ]
  }
}

Note that all filters are assumed to follow $and and by exclusive by default, unless using the $or operator.

That is, sources not meeting those filters will not be used in the chat response.

​

Filtering by URLs

You can filter by the URLs by using the recordUrlsByRegex and recordUrlsByExact patterns as illustrated below.

{
  "attributes": {
    "$and": [
      {
        "recordUrlsByRegex": {
          "$in": [".*inkeep.*"]
        }
      },
      {
        "recordUrlsByExact": {
          "$in": ["https://www.inkeep.com/product/1.0"]
        }
      }
    ]
  }
}

​

Enum Types

​

ChatMode

This enum is used to set the mode of the chat. It can be either AUTO or TURBO.

​

OutputMode

Our API can output conversational outputs (DEFAULT) or only code-snippets in specific a specific programming language.

​

Object Types

​

ChatResult

You don’t have to pass in all the historical chat messages for a conversation, we automatically handle this by creating a chat session with a chatSessionId. For additional messages using the Continue Chat Session, you only need to specify the sessionId and new user message.

​

BotMessage

​

CodeBlock

If using a code-based output mode, this will contain the output as code snippets.

​

ChatCitation

​

How to handle citations in the UI

The content of the bot message will have inline-citations in the format of [^int] where int corresponds to the citationNumber in the ChatCitation object.

To show this in the UX, you can use a regex to extract the inline citations and replace them with the URL of the source as see in the citations object. For example, convert [^int] to [^int](citation[int].url) to add footnotes with the appropriate citation URL. Try out our chat UI to see this in action.

​

PostChatResultSignals (preview)

If you prefer to track usage analytics in your own analytics system instead of ours, we provide analytics in the chat session response that you can use to enrich your own analytics.