Fix stop reason for a few providers

src/providers/ai21/chatComplete.ts

@@ -9,7 +9,9 @@ import {
   generateErrorResponse,
   generateInvalidProviderResponseError,
 } from '../utils';
-import { AI21ErrorResponse } from './complete';
+import { AI21ErrorResponse } from './types';
+import { AI21ChatCompleteResponse } from './types';
+import { transformAI21ChatFinishReason } from './utils';
 
 export const AI21ChatCompleteConfig: ProviderConfig = {
   messages: [
@@ -97,19 +99,6 @@ export const AI21ChatCompleteConfig: ProviderConfig = {
   },
 };
 
-interface AI21ChatCompleteResponse {
-  id: string;
-  outputs: {
-    text: string;
-    role: string;
-    finishReason: {
-      reason: string;
-      length: number | null;
-      sequence: string | null;
-    };
-  }[];
-}
-
 export const AI21ErrorResponseTransform: (
   response: AI21ErrorResponse
 ) => ErrorResponse | undefined = (response) => {
@@ -148,7 +137,7 @@ export const AI21ChatCompleteResponseTransform: (
         },
         index: index,
         logprobs: null,
-        finish_reason: o.finishReason?.reason,
+        finish_reason: transformAI21ChatFinishReason(o.finishReason?.reason),
       })),
     };
   }

src/providers/ai21/complete.ts

@@ -3,6 +3,8 @@ import { Params } from '../../types/requestBody';
 import { CompletionResponse, ErrorResponse, ProviderConfig } from '../types';
 import { generateInvalidProviderResponseError } from '../utils';
 import { AI21ErrorResponseTransform } from './chatComplete';
+import { AI21CompleteResponse, AI21ErrorResponse } from './types';
+import { transformAI21CompletionFinishReason } from './utils';
 
 export const AI21CompleteConfig: ProviderConfig = {
   prompt: {
@@ -65,30 +67,6 @@ export const AI21CompleteConfig: ProviderConfig = {
   },
 };
 
-interface AI21CompleteResponse {
-  id: string;
-  prompt: {
-    text: string;
-    tokens: Record<string, any>[];
-  };
-  completions: [
-    {
-      data: {
-        text: string;
-        tokens: Record<string, any>[];
-      };
-      finishReason: {
-        reason: string;
-        length: number;
-      };
-    },
-  ];
-}
-
-export interface AI21ErrorResponse {
-  detail: string;
-}
-
 export const AI21CompleteResponseTransform: (
   response: AI21CompleteResponse | AI21ErrorResponse,
   responseStatus: number
@@ -116,7 +94,9 @@ export const AI21CompleteResponseTransform: (
         text: completion.data.text,
         index: index,
         logprobs: null,
-        finish_reason: completion.finishReason?.reason,
+        finish_reason: transformAI21CompletionFinishReason(
+          completion.finishReason?.reason
+        ),
       })),
       usage: {
         prompt_tokens: inputTokens,

src/providers/ai21/embed.ts

@@ -1,6 +1,6 @@
 import { ErrorResponse, ProviderConfig } from '../types';
 import { EmbedParams, EmbedResponse } from '../../types/embedRequestBody';
-import { AI21ErrorResponse } from './complete';
+import { AI21ErrorResponse } from './types';
 import { AI21 } from '../../globals';
 import { generateInvalidProviderResponseError } from '../utils';
 import { AI21ErrorResponseTransform } from './chatComplete';

src/providers/ai21/types.ts

@@ -0,0 +1,39 @@
+export enum AI21_FINISH_REASON {
+  stop = 'stop',
+  length = 'length',
+}
+export interface AI21ChatCompleteResponse {
+  id: string;
+  outputs: {
+    text: string;
+    role: string;
+    finishReason: {
+      reason: AI21_FINISH_REASON | string;
+      length: number | null;
+      sequence: string | null;
+    };
+  }[];
+}
+export interface AI21CompleteResponse {
+  id: string;
+  prompt: {
+    text: string;
+    tokens: Record<string, any>[];
+  };
+  completions: [
+    {
+      data: {
+        text: string;
+        tokens: Record<string, any>[];
+      };
+      finishReason: {
+        reason: AI21_FINISH_REASON | string;
+        length: number;
+      };
+    },
+  ];
+}
+
+export interface AI21ErrorResponse {
+  detail: string;
+}

src/providers/ai21/utils.ts

@@ -0,0 +1,31 @@
+import {
+  OPEN_AI_CHAT_COMPLETION_FINISH_REASON,
+  OPEN_AI_COMPLETION_FINISH_REASON,
+} from '../types';
+import { AI21_FINISH_REASON } from './types';
+
+export const transformAI21ChatFinishReason = (
+  reason: AI21_FINISH_REASON | string
+): OPEN_AI_CHAT_COMPLETION_FINISH_REASON => {
+  switch (reason) {
+    case AI21_FINISH_REASON.stop:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.stop;
+    case AI21_FINISH_REASON.length:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.length;
+    default:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.stop;
+  }
+};
+
+export const transformAI21CompletionFinishReason = (
+  reason: AI21_FINISH_REASON | string
+): OPEN_AI_COMPLETION_FINISH_REASON => {
+  switch (reason) {
+    case AI21_FINISH_REASON.stop:
+      return OPEN_AI_COMPLETION_FINISH_REASON.stop;
+    case AI21_FINISH_REASON.length:
+      return OPEN_AI_COMPLETION_FINISH_REASON.length;
+    default:
+      return OPEN_AI_COMPLETION_FINISH_REASON.stop;
+  }
+};

src/providers/anthropic/chatComplete.ts

@@ -9,6 +9,11 @@ import {
   generateErrorResponse,
   generateInvalidProviderResponseError,
 } from '../utils';
+import { ANTHROPIC_STOP_REASON } from './types';
+import {
+  transformAnthropicChatStopReason,
+  transformAnthropicChatStreamChunkStopReason,
+} from './utils';
 
 // TODO: this configuration does not enforce the maximum token limit for the input parameter. If you want to enforce this, you might need to add a custom validation function or a max property to the ParameterConfig interface, and then use it in the input configuration. However, this might be complex because the token count is not a simple length check, but depends on the specific tokenization method used by the model.
 
@@ -290,7 +295,7 @@ export interface AnthropicChatCompleteResponse {
   type: string;
   role: string;
   content: AnthropicContentItem[];
-  stop_reason: string;
+  stop_reason: ANTHROPIC_STOP_REASON | string;
   model: string;
   stop_sequence: null | string;
   usage: {
@@ -306,7 +311,7 @@ export interface AnthropicChatCompleteStreamResponse {
     type: string;
     text: string;
     partial_json?: string;
-    stop_reason?: string;
+    stop_reason: ANTHROPIC_STOP_REASON | string;
   };
   content_block?: {
     type: string;
@@ -351,10 +356,10 @@ export const AnthropicChatCompleteResponseTransform: (
   responseStatus: number
 ) => ChatCompletionResponse | ErrorResponse = (response, responseStatus) => {
   if (responseStatus !== 200) {
-    const errorResposne = AnthropicErrorResponseTransform(
+    const errorResponse = AnthropicErrorResponseTransform(
       response as AnthropicErrorResponse
     );
-    if (errorResposne) return errorResposne;
+    if (errorResponse) return errorResponse;
   }
 
   if ('content' in response) {
@@ -394,7 +399,7 @@ export const AnthropicChatCompleteResponseTransform: (
           },
           index: 0,
           logprobs: null,
-          finish_reason: response.stop_reason,
+          finish_reason: transformAnthropicChatStopReason(response.stop_reason),
         },
       ],
       usage: {
@@ -479,7 +484,9 @@ export const AnthropicChatCompleteStreamChunkTransform: (
           {
             index: 0,
             delta: {},
-            finish_reason: parsedChunk.delta?.stop_reason,
+            finish_reason: transformAnthropicChatStreamChunkStopReason(
+              parsedChunk.delta.stop_reason
+            ),
           },
         ],
         usage: {
@@ -534,7 +541,9 @@ export const AnthropicChatCompleteStreamChunkTransform: (
           },
           index: 0,
           logprobs: null,
-          finish_reason: parsedChunk.delta?.stop_reason ?? null,
+          finish_reason: transformAnthropicChatStreamChunkStopReason(
+            parsedChunk.delta?.stop_reason
+          ),
         },
       ],
     })}` + '\n\n'

src/providers/anthropic/complete.ts

@@ -6,6 +6,11 @@ import {
   AnthropicErrorResponse,
   AnthropicErrorResponseTransform,
 } from './chatComplete';
+import { ANTHROPIC_STOP_REASON } from './types';
+import {
+  transformAnthropicCompletionFinishReason,
+  transformAnthropicCompletionStreamChunkFinishReason,
+} from './utils';
 
 // TODO: this configuration does not enforce the maximum token limit for the input parameter. If you want to enforce this, you might need to add a custom validation function or a max property to the ParameterConfig interface, and then use it in the input configuration. However, this might be complex because the token count is not a simple length check, but depends on the specific tokenization method used by the model.
 
@@ -59,7 +64,7 @@ export const AnthropicCompleteConfig: ProviderConfig = {
 
 interface AnthropicCompleteResponse {
   completion: string;
-  stop_reason: string;
+  stop_reason: ANTHROPIC_STOP_REASON | string;
   model: string;
   truncated: boolean;
   stop: null | string;
@@ -73,10 +78,10 @@ export const AnthropicCompleteResponseTransform: (
   responseStatus: number
 ) => CompletionResponse | ErrorResponse = (response, responseStatus) => {
   if (responseStatus !== 200) {
-    const errorResposne = AnthropicErrorResponseTransform(
+    const errorResponse = AnthropicErrorResponseTransform(
       response as AnthropicErrorResponse
     );
-    if (errorResposne) return errorResposne;
+    if (errorResponse) return errorResponse;
   }
 
   if ('completion' in response) {
@@ -91,7 +96,9 @@ export const AnthropicCompleteResponseTransform: (
           text: response.completion,
           index: 0,
           logprobs: null,
-          finish_reason: response.stop_reason,
+          finish_reason: transformAnthropicCompletionFinishReason(
+            response.stop_reason
+          ),
         },
       ],
     };
@@ -127,7 +134,9 @@ export const AnthropicCompleteStreamChunkTransform: (
           text: parsedChunk.completion,
           index: 0,
           logprobs: null,
-          finish_reason: parsedChunk.stop_reason,
+          finish_reason: transformAnthropicCompletionStreamChunkFinishReason(
+            parsedChunk.stop_reason
+          ),
         },
       ],
     })}` + '\n\n'

src/providers/anthropic/types.ts

@@ -0,0 +1,6 @@
+export enum ANTHROPIC_STOP_REASON {
+  max_tokens = 'max_tokens',
+  stop_sequence = 'stop_sequence',
+  tool_use = 'tool_use',
+  end_turn = 'end_turn',
+}

src/providers/anthropic/utils.ts

@@ -0,0 +1,51 @@
+import {
+  OPEN_AI_CHAT_COMPLETION_FINISH_REASON,
+  OPEN_AI_COMPLETION_FINISH_REASON,
+} from '../types';
+import { ANTHROPIC_STOP_REASON } from './types';
+
+// this converts the anthropic stop_reason to an openai finish_reason
+
+export const transformAnthropicChatStopReason = (
+  stopReason: ANTHROPIC_STOP_REASON | string
+): OPEN_AI_CHAT_COMPLETION_FINISH_REASON => {
+  switch (stopReason) {
+    case ANTHROPIC_STOP_REASON.stop_sequence:
+    case ANTHROPIC_STOP_REASON.end_turn:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.stop;
+    case ANTHROPIC_STOP_REASON.tool_use:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.tool_calls;
+    case ANTHROPIC_STOP_REASON.max_tokens:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.length;
+    default:
+      return OPEN_AI_CHAT_COMPLETION_FINISH_REASON.stop;
+  }
+};
+// finish_reason may be null for stream chunks
+
+export const transformAnthropicChatStreamChunkStopReason = (
+  stopReason?: ANTHROPIC_STOP_REASON | string | null
+): OPEN_AI_CHAT_COMPLETION_FINISH_REASON | null => {
+  if (!stopReason) return null;
+  return transformAnthropicChatStopReason(stopReason);
+};
+export const transformAnthropicCompletionFinishReason = (
+  stopReason: ANTHROPIC_STOP_REASON | string
+): OPEN_AI_COMPLETION_FINISH_REASON => {
+  switch (stopReason) {
+    case ANTHROPIC_STOP_REASON.stop_sequence:
+    case ANTHROPIC_STOP_REASON.end_turn:
+      return OPEN_AI_COMPLETION_FINISH_REASON.stop;
+    case ANTHROPIC_STOP_REASON.tool_use:
+      return OPEN_AI_COMPLETION_FINISH_REASON.length;
+    default:
+      return OPEN_AI_COMPLETION_FINISH_REASON.stop;
+  }
+};
+
+export const transformAnthropicCompletionStreamChunkFinishReason = (
+  stopReason?: ANTHROPIC_STOP_REASON | string | null
+): OPEN_AI_COMPLETION_FINISH_REASON | null => {
+  if (!stopReason) return null;
+  return transformAnthropicCompletionFinishReason(stopReason);
+};

src/providers/anyscale/chatComplete.ts

@@ -2,6 +2,7 @@ import { ANYSCALE } from '../../globals';
 import {
   ChatCompletionResponse,
   ErrorResponse,
+  OPEN_AI_CHAT_COMPLETION_FINISH_REASON,
   ProviderConfig,
 } from '../types';
 import {
@@ -111,7 +112,7 @@ export interface AnyscaleStreamChunk {
       content?: string;
     };
     index: number;
-    finish_reason: string | null;
+    finish_reason: OPEN_AI_CHAT_COMPLETION_FINISH_REASON | null;
   }[];
 }
 
@@ -165,10 +166,10 @@ export const AnyscaleChatCompleteResponseTransform: (
   responseStatus: number
 ) => ChatCompletionResponse | ErrorResponse = (response, responseStatus) => {
   if (responseStatus !== 200) {
-    const errorResposne = AnyscaleErrorResponseTransform(
+    const errorResponse = AnyscaleErrorResponseTransform(
       response as AnyscaleErrorResponse | AnyscaleValidationErrorResponse
     );
-    if (errorResposne) return errorResposne;
+    if (errorResponse) return errorResponse;
   }
 
   if ('choices' in response) {