> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inquantum.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Trace Any Vector DB interactions
> Log any Vector DB interactions using Planck's Logger SDK.
export const strings = {
additionalHeadersForSessions: "Planck provides additional headers to help you manage and analyze your sessions.",
azureOpenAIDocs: `To learn more about the differences between OpenAI and AzureOpenAI, review the documentation here.`,
chainOfThoughtPromptingCookbookDescription: "Craft effective prompts, ideal for complex responses requiring multi-step problem solving.",
chatbotCookbookDescription: "This step-by-step guide covers function calling, response formatting and monitoring with Planck.",
createPlanckManualLogger: "Create a new PlanckManualLogger instance",
configureWebSocketConnection: "Configure WebSocket connection",
environmentTrackingCookbookDescription: "Effortlessly track and manage your environments with Planck across different deployment contexts.",
exportBaseUrl: tool => `Export your ${tool} base URL`,
getStartedWithPackage: "To get started, install the @inquantum/planck-helpers package",
generateKey: "Create an account and generate an API key",
generateKeyInstructions: `Log into Planck or create an account. Once you have an account, you can generate an API key here.`,
generateSessionId: "Generate the unique session ID that will be used to track the session.",
gettingUserRequestsCookbookDescription: "Retrieve user-specific requests to monitor, debug, and track costs for individual users.",
groupingCallsWithSessions: "Grouping Calls with Planck Sessions",
handleWebSocketEvents: "Handle WebSocket events",
planckLoggerAPIReference: `To learn more about the PlanckManualLogger API, see the API Reference here.`,
howToIntegrate: "How to Integrate",
howToPromptThinkingModelsCookbookDescription: "Best practices to to effectively prompt thinking models like Deepseek and OpenAI o1-o3 for optimal results.",
howToUseSessions: "To group related API calls and analyze them collectively, you can use Planck's session tracking features. This is useful for grouping all interactions within a single conversation or user session.",
includeHeadersInRequests: "Include headers in your requests",
includeSessionHeaders: "Include the session headers when you make API requests. This way, the session information is attached to each request, allowing Planck to group and analyze them together.",
installRequiredDependencies: "Install required dependencies",
installSDK: tool => `Install ${tool}`,
logYourRequest: "Log your request",
modifyBasePath: "Modify the base URL path and set up authentication",
optional: "Optional",
relatedGuides: "Related documentation",
replayLlmSessionsCookbookDescription: "Learn how to replay and modify LLM sessions using Planck to optimize your AI agents and improve their performance.",
sessionManagement: "Session Management",
setApiKey: "Set up your Planck API key in your .env file",
setUpToolBaseUrl: tool => `Set up your ${tool} base URL`,
setUpToolApiKey: tool => `Set up your ${tool} API key as an environment variable`,
startUsing: tool => `Start using ${tool} with Planck`,
useTheSDK: tool => `Use the ${tool} SDK`,
verifyInPlanck: "Verify your requests in Planck",
verifyInPlanckDescription: tool => `With the above setup, any calls to ${tool} will automatically be logged and monitored by Planck. Review them in your Planck dashboard.`,
whyUseSessions: "By including the session headers in each request, you have more granular control over session tracking. This approach is especially useful if you want to handle sessions dynamically or manage multiple sessions concurrently.",
viewRequestsInDashboard: "View requests in the Planck dashboard",
viewRequestsInDashboardDescription: product => `All your ${product} requests are now visible in your Planck dashboard`,
modelRegistryDescription: "You can find all 100+ supported models at inquantum.ai/models."
};
```bash npm theme={null}
npm install @inquantum/planck-helpers
```
```bash pip theme={null}
pip install planck-helpers
```
```bash theme={null}
export PLANCK_API_KEY=
```
```js js theme={null}
import { PlanckManualLogger } from "@inquantum/planck-helpers";
const planckLogger = new PlanckManualLogger({
apiKey: process.env.PLANCK_API_KEY, // Can be set as env variable
headers: {} // Additional headers to be sent with the request
});
```
```python python theme={null}
import os
from planck_helpers import PlanckManualLogger, PlanckResultRecorder
planck_logger = PlanckManualLogger(
api_key=os.environ["PLANCK_API_KEY"],
headers={} # Additional headers to be sent with the request
)
```
```js js theme={null}
const res = await planckLogger.logRequest(
{
_type: "vector_db",
operation: "search", // The operation performed. In this case, search.
// ...include any other data about the vector db request here (look at the API reference for more details)
},
async (resultRecorder) => {
// Your vector db operation here. In this case, search
const searchResults = await vectorDB.search({
query: "Find similar products to iPhone",
limit: 3
});
// Log the results
resultRecorder.appendResults({
// These are the results of the operation that Planck will log
products: searchResults.map(result => ({
name: result.name,
price: result.price
}))
});
return searchResults;
}
);
```
```python python theme={null}
def vector_db_operation(result_recorder: PlanckResultRecorder):
# Your vector db operation here. In this case, search
search_results = vector_db.search(
query="Find similar products to iPhone",
limit=3
)
# Log the results
result_recorder.append_results({
# These are the results of the operation that Planck will log
"products": [
{
"name": result["name"],
"price": result["price"]
}
for result in search_results
]
})
return search_results
res = planck_logger.log_request(
request={
"_type": "vector_db",
"operation": "search", # The operation performed. In this case, search.
# ...include any other data about the vector db request here (look at the API reference for more details)
},
operation=vector_db_operation
)
```