feat: add krutrim as provider #1201
Conversation
|
DescriptionSummary By MatterAI
🔄 What ChangedThis pull request introduces Krutrim as a new AI provider. Key changes include:
🔍 Impact of the ChangeThis change significantly expands the platform's capabilities by adding support for a new AI model provider, Krutrim. It allows applications to integrate with Krutrim's chat completion services, providing more options for users and potentially improving model diversity. The new files establish a clear, modular structure for integrating future providers. 📁 Total Files Changed5 files changed. 🧪 Test AddedNo specific tests were added or mentioned in the pull request data. 🔒Security VulnerabilitiesNo direct security vulnerabilities were detected in the provided patch. The API key is handled via MotivationKrutrim provider integration Type of Change
How Has This Been Tested?
Screenshots (if applicable)N/A Checklist
Related IssuesN/A Tip Quality Recommendations
Sequence DiagramsequenceDiagram
participant User
participant Application
participant ProvidersMap as src/providers/index.ts
participant KrutrimConfigModule as src/providers/krutrim/index.ts
participant KrutrimAPIConfigModule as src/providers/krutrim/api.ts
participant KrutrimAPI as Krutrim Cloud API
participant KrutrimResponseTransform as src/providers/krutrim/chatComplete.ts
User->>Application: Initiates chat completion request
Application->>ProvidersMap: Get ProviderConfig for 'krutrim'
ProvidersMap->>KrutrimConfigModule: Import KrutrimConfig
KrutrimConfigModule-->>ProvidersMap: Provides KrutrimConfig (api, chatComplete, responseTransforms)
ProvidersMap-->>Application: Returns KrutrimConfig
Application->>KrutrimAPIConfigModule: Call getBaseURL() & headers({providerOptions: {apiKey}, fn: 'chatComplete'})
KrutrimAPIConfigModule-->>Application: Returns Base URL (https://cloud.olakrutrim.com/v1) and Headers (Authorization: Bearer <apiKey>)
Application->>KrutrimAPIConfigModule: Call getEndpoint({fn: 'chatComplete'})
KrutrimAPIConfigModule-->>Application: Returns Endpoint (/chat/completions)
Application->>KrutrimAPI: POST /chat/completions (with request body and headers)
KrutrimAPI-->>Application: Returns API Response (status, body)
Application->>KrutrimResponseTransform: Call KrutrimChatCompleteResponseTransform(response, responseStatus)
KrutrimResponseTransform->>KrutrimResponseTransform: Checks responseStatus (e.g., 200) and 'html-message' for errors
alt If error (status != 200 && 'html-message' present)
KrutrimResponseTransform->>KrutrimResponseTransform: Calls generateErrorResponse(errorDetails, KRUTRIM)
end
KrutrimResponseTransform-->>Application: Returns Transformed ChatCompletionResponse or ErrorResponse
Application-->>User: Returns Chat Completion Result
|
![matter-code-review[bot]](https://avatars.githubusercontent.com/in/474549?s=60&v=4){kind=small}
| if (responseStatus !== 200 && 'html-message' in response) { | ||
| // Handle Krutrim's error format | ||
| return generateErrorResponse( | ||
| { | ||
| message: response['html-message'] ?? '', | ||
| type: 'error', | ||
| param: null, | ||
| code: String(responseStatus), | ||
| }, | ||
| KRUTRIM | ||
| ); | ||
| } |
There was a problem hiding this comment.
🛠️ Code Refactor
Issue: The error handling only checks for 'html-message' property but doesn't handle standard error responses that might not have this property.
Fix: Add a more comprehensive error handling approach that can handle both Krutrim-specific and standard error formats.
Impact: Improves error handling robustness and prevents potential unhandled error scenarios.
| if (responseStatus !== 200 && 'html-message' in response) { | |
| // Handle Krutrim's error format | |
| return generateErrorResponse( | |
| { | |
| message: response['html-message'] ?? '', | |
| type: 'error', | |
| param: null, | |
| code: String(responseStatus), | |
| }, | |
| KRUTRIM | |
| ); | |
| } | |
| if (responseStatus !== 200) { | |
| // Handle Krutrim's error format | |
| return generateErrorResponse( | |
| { | |
| message: 'html-message' in response ? response['html-message'] ?? '' : 'Unknown error from Krutrim API', | |
| type: 'error', | |
| param: null, | |
| code: String(responseStatus), | |
| }, | |
| KRUTRIM | |
| ); | |
| } |
| headers: ({ providerOptions, fn }) => { | ||
| const headersObj: Record<string, string> = { | ||
| Authorization: `Bearer ${providerOptions.apiKey}`, | ||
| }; | ||
| return headersObj; | ||
| }, |
There was a problem hiding this comment.
⚡️ Performance Improvement
Issue: The headers function creates a new object on every call, which is unnecessary since the object structure is static.
Fix: Optimize the headers function to directly return the object without the intermediate variable.
Impact: Slightly improves performance by reducing unnecessary object creation and variable assignment.
| headers: ({ providerOptions, fn }) => { | |
| const headersObj: Record<string, string> = { | |
| Authorization: `Bearer ${providerOptions.apiKey}`, | |
| }; | |
| return headersObj; | |
| }, | |
| headers: ({ providerOptions, fn }) => { | |
| return { | |
| Authorization: `Bearer ${providerOptions.apiKey}`, | |
| }; | |
| }, |
| import { ChatCompletionResponse, ErrorResponse } from '../types'; | ||
|
|
||
| import { generateErrorResponse } from '../utils'; | ||
|
|
||
| import { KRUTRIM } from '../../globals'; | ||
|
|
||
| interface KrutrimChatCompleteResponse extends ChatCompletionResponse {} | ||
| interface KrutrimChatCompleteErrorResponse extends ErrorResponse { | ||
| 'html-message'?: string; | ||
| } |
There was a problem hiding this comment.
🛠️ Code Refactor
Issue: The interface KrutrimChatCompleteResponse is defined but doesn't add any properties beyond the base ChatCompletionResponse.
Fix: Either add Krutrim-specific properties to the interface or use the base type directly to simplify the code.
Impact: Improves code clarity and maintainability by avoiding unnecessary type definitions.
| import { ChatCompletionResponse, ErrorResponse } from '../types'; | |
| import { generateErrorResponse } from '../utils'; | |
| import { KRUTRIM } from '../../globals'; | |
| interface KrutrimChatCompleteResponse extends ChatCompletionResponse {} | |
| interface KrutrimChatCompleteErrorResponse extends ErrorResponse { | |
| 'html-message'?: string; | |
| } | |
| import { ChatCompletionResponse, ErrorResponse } from '../types'; | |
| import { generateErrorResponse } from '../utils'; | |
| import { KRUTRIM } from '../../globals'; | |
| interface KrutrimChatCompleteErrorResponse extends ErrorResponse { | |
| 'html-message'?: string; | |
| } |
|
@narengogi can you take a look at this PR? |
src/providers/krutrim/index.ts
Outdated
| api: KrutrimAPIConfig, | ||
| chatComplete: chatCompleteParams([ | ||
| 'max_tokens', | ||
| 'temperature', |
There was a problem hiding this comment.
I can see that these parameters are supported in the API signature
There was a problem hiding this comment.
Hi @narengogi,
I've pushed a commit to remove the excludes. I had mistakenly marked the params as required.
additionally, added a default model.
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
4 participants
Description
Type of Change