Custom properties allows you to add any additional information to your logs, which can help you tag and filter logs.
A custom property is a key-value pair that you can add to an LLM log when sending an LLM log to Keywords AI. It can help you tag and filter LLM logs.
You can pass custom properties to Keyworeds AI by adding a metadata
field to the request body.
Here is an example of how to send 2 custom metadata to Keywords AI in the OpenAI Python SDK.
To use custom properties for filtering in the dashboard, you need to index the custom properties in the platform, otherwise the custom properties will not be available for filtering.
Filtering by custom properties in the dashboard is only available for Team plan and Enterprise plan users.
Go to Customer Properties page and click on the Create index
button to index custom properties you want to filter by.
After indexing the custom properties, you can filter the dashboard metrics by the custom properties.
You can also filter logs by custom properties on the Logs page. Just click on the Filter
button to filter the logs by the Custom properties
.
You can also update the custom properties of a log through the API.
Here are the steps to update the custom properties of a log:
Get unique_id of the log
You need first to get the unique_id
of the log you want to update. You can get the unique_id
from the Logs list endpoint. OR you can get the unique_id
from Logs page’s Log ID
column.
Send the API request
Pass the unique_id
to the /api/request-logs/batch-update/
endpoint with the metadata and notes you want to update.