Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

HAi Providers

Hornbill AI utilizes the latest advancements in generative AI from world class providers, by default this provider is OpenAI; making use of the latest models available to use Hornbill AI out of the box prompts are tailed to provide the best experience possible. OpenAI data processing is not locked to a specific region nor do they currently provide API integrations like ours any control of which region the prompts are processed in, for this reason a second generative AI provider was added Azure Open AI Service. When signing up for Hornbill AI you will be asked which of the two providers you governance teams are happy to engage with and if Azure Open AI Service is selected generative AI processing will be limited to the region your Hornbill Instance is hosted in, so a UK Customer will have all generative AI processing performed in the UK utilizing a Microsoft Azure region for the UK.

It is possible to change providers after the initial selection and reaching out to your customer success contact is the best point of call for this, the ability for a customer to change this is currently limited to prevent accidental change by an administrator that goes against the agreement of a customers governance and compliance teams.

HAi Provider Details

Currently their is no UI for showing which HAI Provider your instance is configured with, reach out to customer success if in doubt and the current setup can be clarified.

OpenAI

Data from prompts and underlying request data is passed to OpenAI under their business terms of use and their enterprise privacy policy. This prevents usage data from being used for training new models, the input and output of prompts is currently stored by OpenAI as outlined in their Documentation, all data is sent using encrypted connection.

Data Processing

OpenAIs Data Processing Addendum covers any specifics they have documented on any possible international transfer of data.

Usage

Usage of the OpenAI API’s goes through an API Key provided by hornbill. Currently there are no usage limits outside the limits provided by OpenAI. It is possible to override the API to use an API Key of your organization’s choice by overriding the system setting integration.hai.openai.apiKey.

Further details on this here: https://docs.hornbill.com/esp-fundamentals/productivity/ai-assist

Azure AI Service

Azure OpenAI Services is an Azure services provided by microsoft that hosts OpenAI Models in Azure regions for use by Microsoft customers, unlike dealing with OpenAI directly this allows a API integration with a OpenAI model to have guarantees on where data is being processed. The underlying models are the same so the functionality provided by the API integration back to the end user is the same (model availability depending).

Data Processing

Data from prompts and underlying request data is passed to Azure for processing in a specific region, unless otherwise requested this region will be the same geographic region that your Hornbill Instance is hosted on, details on how Azure processing this data can be found here.

As with OpenAI, Azure OpenAI Services has a built in abuse monitor that logs input and output prompts, these are stored in the same region and kept for 30 days, details can be found in their data privacy details.

Usage

Usage of the Azure OpenAI Services API’s is provided through deployments managed by Hornbill. Currently there are no usage limits outside the limits provided by Azure, It is possible for a customer to provider their own Azure OpenAI Services deployment details instead of using the deployment provided by Hornbill, reach out to you customer success contact to discuss this.

Provider terms of use

Details on each providers usage policy as well as Hornbill’s can be found here

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document