Skip to main content

Project Settings

Overview​

The project settings screen allow the project admin to change the properties of the project.

Project Settings management interface. It provides details of a 'Sample Project', including the project name, a unique ID, the creation date, and the last modification date. The ability to change 'Embeddings' model. There's an 'API Keys' section listing a default key

Embeddings​

  • ADA V2 (text-embedding-ada-002) is the original embedding model. For projects using this model, we recommend upgrading

  • Text Embedding Small (text-embedding-3-small). This model has enhanced performance over ADA V2 and costs less. Recommended for English projects.

  • Text Embedding large (text-embedding-3-large) is recommended for projects involving non-English content, as it offers enhanced performance capabilities better suited for diverse linguistic datasets. However, please be aware that this comes at a higher cost.

The image shows a software interface for selecting text embedding models, with options for ADA v2, a cost-effective Text Embedding 3 Small (New), and a more capable but expensive Text Embedding 3 Large for non-English content. Users are advised to upgrade from ADA v2 and have buttons to either cancel or save their choice.

CMS Connectors​

CMS connectors need to be enabled in the Organization settings. Then Enable in the project.

API Keys Management Documentation​

Creating an API Key​

To create an API key:

  1. Navigate to the "API Keys" section in your account settings.

  2. Click on the "Create API Key" button. A dialog box will appear, prompting you to name your API key.

    'Create API Key' form with a field labeled 'Name' for entering the API Key name. There are 'Cancel' and 'Save' buttons below the input field

  3. Enter a meaningful name for your API key. The name should reflect the source or the intended use of the API key to help you organize and identify the key later. For instance, if you're creating a key for your web application, you might name it "Web" or something more specific to the service it will access.

  4. Click "Save" to generate the API key. Your new key will now appear in the list of API keys with its name, creation date, and status indicated.

    'API Keys' section in a web interface. There are two API keys listed. The first is named 'Web' with a complex key string, marked as 'Active' and created by. The second is named 'Mobile' with a different key string, also 'Active'. Each key has an icon suggesting the ability to copy the key to the clipboard and a menu for further actions indicated by a vertical ellipsis.

  5. Once the key is created, it's active and ready to use. The key will be a unique alphanumeric string that you should keep confidential.

Deleting an API Key​

To delete an API key:

  1. In the "API Keys" section, locate the key you wish to delete.

  2. Click on the action button (three dots) on the right side of the key's entry.

    The keys action button (three dots) on the right side of the key's entry. showing the action to Archive or Delete

  3. Choose "Archive" to deactivate the API key. Confirm the action if prompted.

  4. Once archived, the API key is no longer active and cannot be used to access the API.

Note on API Key Usage​

The name you assign to your API key serves as an identifier for filtering data and understanding the source of the API traffic. By using descriptive names tied to their use cases—such as "Mobile" for mobile apps or "Analytics" for data analysis—you can easily keep track of the different ways your API keys are used and monitor their activity. Always keep your API keys secure to prevent unauthorized use.

Project Organization Information​

This information is created by AI, when creating the project. You can edit this information if more relevant information is available. This information is used to provide context when creating knowledge base articles or categories.

Replace Words​

Replace words used to change a string of words with another string. Replace words is not case sensitive. Example use, if you are dealing with a drug, you might change the word drug with the real drug name.

Screenshot of the 'Replace Words' tab in a project settings interface. It shows a section where you can enter a word to be replaced and the word to replace it with, alongside an 'Add' button. Below is a table with two columns, 'Replace Word' and 'Replace With', displaying an example where 'ai1toz' is set to be replaced with 'ai12z'. There's an action menu indicated by a vertical ellipsis on the far right of the entry.