Rename model specification export to ai/spec. (#1237)

vercel · Mar 27, 2024 · cf8d12f · cf8d12f
1 parent 98b144f
commit cf8d12f
Show file tree

Hide file tree

Showing 69 changed files with 54 additions and 61 deletions.
diff --git a/.changeset/smart-nails-doubt.md b/.changeset/smart-nails-doubt.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+Export experimental language model specification under `ai/spec`.
diff --git a/packages/core/core/generate-object/generate-object.ts b/packages/core/core/generate-object/generate-object.ts
@@ -6,7 +6,7 @@ import {
   LanguageModelV1FinishReason,
   NoTextGeneratedError,
   safeParseJSON,
-} from '../../ai-model-specification';
+} from '../../spec';
 import { TokenUsage, calculateTokenUsage } from '../generate-text/token-usage';
 import { CallSettings } from '../prompt/call-settings';
 import { convertToLanguageModelPrompt } from '../prompt/convert-to-language-model-prompt';

diff --git a/packages/core/core/generate-object/stream-object.ts b/packages/core/core/generate-object/stream-object.ts
@@ -5,7 +5,7 @@ import {
   LanguageModelV1CallOptions,
   LanguageModelV1CallWarning,
   LanguageModelV1StreamPart,
-} from '../../ai-model-specification';
+} from '../../spec';
 import { CallSettings } from '../prompt/call-settings';
 import { convertToLanguageModelPrompt } from '../prompt/convert-to-language-model-prompt';
 import { getInputFormat } from '../prompt/get-input-format';

diff --git a/packages/core/core/generate-text/generate-text.ts b/packages/core/core/generate-text/generate-text.ts
@@ -3,7 +3,7 @@ import {
   LanguageModelV1,
   LanguageModelV1CallWarning,
   LanguageModelV1FinishReason,
-} from '../../ai-model-specification';
+} from '../../spec';
 import { CallSettings } from '../prompt/call-settings';
 import { convertToLanguageModelPrompt } from '../prompt/convert-to-language-model-prompt';
 import { getInputFormat } from '../prompt/get-input-format';

diff --git a/packages/core/core/generate-text/run-tools-transformation.ts b/packages/core/core/generate-text/run-tools-transformation.ts
@@ -1,7 +1,4 @@
-import {
-  LanguageModelV1StreamPart,
-  NoSuchToolError,
-} from '../../ai-model-specification';
+import { LanguageModelV1StreamPart, NoSuchToolError } from '../../spec';
 import { generateId } from '../../shared/generate-id';
 import { ExperimentalTool } from '../tool';
 import { TextStreamPart } from './stream-text';

diff --git a/packages/core/core/generate-text/stream-text.ts b/packages/core/core/generate-text/stream-text.ts
@@ -1,9 +1,6 @@
 import zodToJsonSchema from 'zod-to-json-schema';
-import { LanguageModelV1FinishReason } from '../../ai-model-specification';
-import {
-  LanguageModelV1,
-  LanguageModelV1CallWarning,
-} from '../../ai-model-specification/index';
+import { LanguageModelV1FinishReason } from '../../spec';
+import { LanguageModelV1, LanguageModelV1CallWarning } from '../../spec/index';
 import {
   AIStreamCallbacksAndOptions,
   createCallbacksTransformer,

diff --git a/packages/core/core/generate-text/tool-call.ts b/packages/core/core/generate-text/tool-call.ts
@@ -4,7 +4,7 @@ import {
   LanguageModelV1FunctionToolCall,
   NoSuchToolError,
   safeParseJSON,
-} from '../../ai-model-specification';
+} from '../../spec';
 import { ExperimentalTool } from '../tool';
 import { ValueOf } from '../util/value-of';
 

diff --git a/packages/core/core/prompt/convert-to-language-model-prompt.ts b/packages/core/core/prompt/convert-to-language-model-prompt.ts
@@ -3,7 +3,7 @@ import {
   LanguageModelV1Message,
   LanguageModelV1Prompt,
   LanguageModelV1TextPart,
-} from '../../ai-model-specification';
+} from '../../spec';
 import { convertDataContentToUint8Array } from './data-content';
 import { Prompt } from './prompt';
 

diff --git a/packages/core/core/prompt/data-content.ts b/packages/core/core/prompt/data-content.ts
@@ -2,7 +2,7 @@ import {
   InvalidDataContentError,
   convertBase64ToUint8Array,
   convertUint8ArrayToBase64,
-} from '../../ai-model-specification';
+} from '../../spec';
 
 /**
  * Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.

diff --git a/packages/core/core/prompt/prepare-call-settings.ts b/packages/core/core/prompt/prepare-call-settings.ts
@@ -1,5 +1,5 @@
 import { CallSettings } from './call-settings';
-import { InvalidArgumentError } from '../../ai-model-specification';
+import { InvalidArgumentError } from '../../spec';
 
 /**
  * Validates call settings and sets default values.

diff --git a/packages/core/core/test/mock-language-model-v1.ts b/packages/core/core/test/mock-language-model-v1.ts
@@ -1,4 +1,4 @@
-import { LanguageModelV1 } from '../../ai-model-specification/index';
+import { LanguageModelV1 } from '../../spec/index';
 
 export class MockLanguageModelV1 implements LanguageModelV1 {
   readonly specificationVersion = 'v1';

diff --git a/packages/core/core/util/retry-with-exponential-backoff.ts b/packages/core/core/util/retry-with-exponential-backoff.ts
@@ -1,8 +1,4 @@
-import {
-  APICallError,
-  RetryError,
-  getErrorMessage,
-} from '../../ai-model-specification';
+import { APICallError, RetryError, getErrorMessage } from '../../spec';
 import { delay } from './delay';
 
 export type RetryFunction = <OUTPUT>(

diff --git a/packages/core/mistral/convert-to-mistral-chat-messages.ts b/packages/core/mistral/convert-to-mistral-chat-messages.ts
@@ -1,7 +1,4 @@
-import {
-  LanguageModelV1Prompt,
-  UnsupportedFunctionalityError,
-} from '../ai-model-specification';
+import { LanguageModelV1Prompt, UnsupportedFunctionalityError } from '../spec';
 import { MistralChatPrompt } from './mistral-chat-prompt';
 
 export function convertToMistralChatMessages({

diff --git a/packages/core/mistral/map-mistral-finish-reason.ts b/packages/core/mistral/map-mistral-finish-reason.ts
@@ -1,4 +1,4 @@
-import { LanguageModelV1FinishReason } from '../ai-model-specification';
+import { LanguageModelV1FinishReason } from '../spec';
 
 export function mapMistralFinishReason(
   finishReason: string | null | undefined,

diff --git a/packages/core/mistral/mistral-chat-language-model.test.ts b/packages/core/mistral/mistral-chat-language-model.test.ts
@@ -1,8 +1,8 @@
 import zodToJsonSchema from 'zod-to-json-schema';
-import { LanguageModelV1Prompt } from '../ai-model-specification';
-import { convertStreamToArray } from '../ai-model-specification/test/convert-stream-to-array';
-import { JsonTestServer } from '../ai-model-specification/test/json-test-server';
-import { StreamingTestServer } from '../ai-model-specification/test/streaming-test-server';
+import { LanguageModelV1Prompt } from '../spec';
+import { convertStreamToArray } from '../spec/test/convert-stream-to-array';
+import { JsonTestServer } from '../spec/test/json-test-server';
+import { StreamingTestServer } from '../spec/test/streaming-test-server';
 import { Mistral } from './mistral-facade';
 import { z } from 'zod';
 

diff --git a/packages/core/mistral/mistral-chat-language-model.ts b/packages/core/mistral/mistral-chat-language-model.ts
@@ -9,7 +9,7 @@ import {
   createEventSourceResponseHandler,
   createJsonResponseHandler,
   postJsonToApi,
-} from '../ai-model-specification';
+} from '../spec';
 import { convertToMistralChatMessages } from './convert-to-mistral-chat-messages';
 import { mapMistralFinishReason } from './map-mistral-finish-reason';
 import {

diff --git a/packages/core/mistral/mistral-error.ts b/packages/core/mistral/mistral-error.ts
@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { createJsonErrorResponseHandler } from '../ai-model-specification';
+import { createJsonErrorResponseHandler } from '../spec';
 
 const mistralErrorDataSchema = z.object({
   object: z.literal('error'),

diff --git a/packages/core/mistral/mistral-facade.ts b/packages/core/mistral/mistral-facade.ts
@@ -1,4 +1,4 @@
-import { generateId, loadApiKey } from '../ai-model-specification';
+import { generateId, loadApiKey } from '../spec';
 import { MistralChatLanguageModel } from './mistral-chat-language-model';
 import {
   MistralChatModelId,

diff --git a/packages/core/openai/convert-to-openai-chat-messages.ts b/packages/core/openai/convert-to-openai-chat-messages.ts
@@ -1,7 +1,4 @@
-import {
-  LanguageModelV1Prompt,
-  convertUint8ArrayToBase64,
-} from '../ai-model-specification';
+import { LanguageModelV1Prompt, convertUint8ArrayToBase64 } from '../spec';
 import { OpenAIChatPrompt } from './openai-chat-prompt';
 
 export function convertToOpenAIChatMessages(

diff --git a/packages/core/openai/convert-to-openai-completion-prompt.ts b/packages/core/openai/convert-to-openai-completion-prompt.ts
@@ -2,7 +2,7 @@ import {
   InvalidPromptError,
   LanguageModelV1Prompt,
   UnsupportedFunctionalityError,
-} from '../ai-model-specification';
+} from '../spec';
 
 export function convertToOpenAICompletionPrompt({
   prompt,

diff --git a/packages/core/openai/map-openai-finish-reason.ts b/packages/core/openai/map-openai-finish-reason.ts
@@ -1,4 +1,4 @@
-import { LanguageModelV1FinishReason } from '../ai-model-specification';
+import { LanguageModelV1FinishReason } from '../spec';
 
 export function mapOpenAIFinishReason(
   finishReason: string | null | undefined,

diff --git a/packages/core/openai/openai-chat-language-model.test.ts b/packages/core/openai/openai-chat-language-model.test.ts
@@ -1,9 +1,9 @@
 import { z } from 'zod';
 import zodToJsonSchema from 'zod-to-json-schema';
-import { LanguageModelV1Prompt } from '../ai-model-specification';
-import { convertStreamToArray } from '../ai-model-specification/test/convert-stream-to-array';
-import { JsonTestServer } from '../ai-model-specification/test/json-test-server';
-import { StreamingTestServer } from '../ai-model-specification/test/streaming-test-server';
+import { LanguageModelV1Prompt } from '../spec';
+import { convertStreamToArray } from '../spec/test/convert-stream-to-array';
+import { JsonTestServer } from '../spec/test/json-test-server';
+import { StreamingTestServer } from '../spec/test/streaming-test-server';
 import { OpenAI } from './openai-facade';
 
 const TEST_PROMPT: LanguageModelV1Prompt = [

diff --git a/packages/core/openai/openai-chat-language-model.ts b/packages/core/openai/openai-chat-language-model.ts
@@ -12,7 +12,7 @@ import {
   isParseableJson,
   postJsonToApi,
   scale,
-} from '../ai-model-specification';
+} from '../spec';
 import { convertToOpenAIChatMessages } from './convert-to-openai-chat-messages';
 import { mapOpenAIFinishReason } from './map-openai-finish-reason';
 import { OpenAIChatModelId, OpenAIChatSettings } from './openai-chat-settings';

diff --git a/packages/core/openai/openai-completion-language-model.test.ts b/packages/core/openai/openai-completion-language-model.test.ts
@@ -1,7 +1,7 @@
-import { LanguageModelV1Prompt } from '../ai-model-specification';
-import { convertStreamToArray } from '../ai-model-specification/test/convert-stream-to-array';
-import { JsonTestServer } from '../ai-model-specification/test/json-test-server';
-import { StreamingTestServer } from '../ai-model-specification/test/streaming-test-server';
+import { LanguageModelV1Prompt } from '../spec';
+import { convertStreamToArray } from '../spec/test/convert-stream-to-array';
+import { JsonTestServer } from '../spec/test/json-test-server';
+import { StreamingTestServer } from '../spec/test/streaming-test-server';
 import { OpenAI } from './openai-facade';
 
 const TEST_PROMPT: LanguageModelV1Prompt = [

diff --git a/packages/core/openai/openai-completion-language-model.ts b/packages/core/openai/openai-completion-language-model.ts
@@ -9,7 +9,7 @@ import {
   createJsonResponseHandler,
   postJsonToApi,
   scale,
-} from '../ai-model-specification';
+} from '../spec';
 import { convertToOpenAICompletionPrompt } from './convert-to-openai-completion-prompt';
 import { mapOpenAIFinishReason } from './map-openai-finish-reason';
 import {

diff --git a/packages/core/openai/openai-error.ts b/packages/core/openai/openai-error.ts
@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { createJsonErrorResponseHandler } from '../ai-model-specification';
+import { createJsonErrorResponseHandler } from '../spec';
 
 const openAIErrorDataSchema = z.object({
   error: z.object({

diff --git a/packages/core/openai/openai-facade.ts b/packages/core/openai/openai-facade.ts
@@ -1,4 +1,4 @@
-import { loadApiKey } from '../ai-model-specification';
+import { loadApiKey } from '../spec';
 import { OpenAIChatLanguageModel } from './openai-chat-language-model';
 import { OpenAIChatModelId, OpenAIChatSettings } from './openai-chat-settings';
 import { OpenAICompletionLanguageModel } from './openai-completion-language-model';

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -14,13 +14,13 @@
     "solid/dist/**/*",
     "prompts/dist/**/*",
     "rsc/dist/**/*",
-    "ai-model-specification/dist/**/*",
+    "spec/dist/**/*",
     "openai/dist/**/*",
     "mistral/dist/**/*"
   ],
   "scripts": {
     "build": "tsup && cat react/dist/index.server.d.ts >> react/dist/index.d.ts",
-    "clean": "rm -rf dist && rm -rf core/dist && rm -rf openai/dist && rm -rf mistral/dist && rm -rf ai-model-specification/dist && rm -rf react/dist && rm -rf svelte/dist && rm -rf vue/dist && rm -rf solid/dist && rm -rf rsc/dist",
+    "clean": "rm -rf dist && rm -rf core/dist && rm -rf openai/dist && rm -rf mistral/dist && rm -rf spec/dist && rm -rf react/dist && rm -rf svelte/dist && rm -rf vue/dist && rm -rf solid/dist && rm -rf rsc/dist",
     "dev": "tsup --watch",
     "lint": "eslint \"./**/*.ts*\"",
     "type-check": "tsc --noEmit",
@@ -48,11 +48,11 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
     },
-    "./ai-model-specification": {
-      "types": "./ai-model-specification/dist/index.d.ts",
-      "import": "./ai-model-specification/dist/index.mjs",
-      "module": "./ai-model-specification/dist/index.mjs",
-      "require": "./ai-model-specification/dist/index.js"
+    "./spec": {
+      "types": "./spec/dist/index.d.ts",
+      "import": "./spec/dist/index.mjs",
+      "module": "./spec/dist/index.mjs",
+      "require": "./spec/dist/index.js"
     },
     "./openai": {
       "types": "./openai/dist/index.d.ts",

diff --git a/...el-specification/errors/api-call-error.ts → packages/core/spec/errors/api-call-error.ts b/...el-specification/errors/api-call-error.ts → packages/core/spec/errors/api-call-error.ts
diff --git a/...re/ai-model-specification/errors/index.ts → packages/core/spec/errors/index.ts b/...re/ai-model-specification/errors/index.ts → packages/core/spec/errors/index.ts
diff --git a/...fication/errors/invalid-argument-error.ts → ...ore/spec/errors/invalid-argument-error.ts b/...fication/errors/invalid-argument-error.ts → ...ore/spec/errors/invalid-argument-error.ts
diff --git a/...tion/errors/invalid-data-content-error.ts → ...spec/errors/invalid-data-content-error.ts b/...tion/errors/invalid-data-content-error.ts → ...spec/errors/invalid-data-content-error.ts
diff --git a/...cification/errors/invalid-prompt-error.ts → .../core/spec/errors/invalid-prompt-error.ts b/...cification/errors/invalid-prompt-error.ts → .../core/spec/errors/invalid-prompt-error.ts
diff --git a/...ion/errors/invalid-response-data-error.ts → ...pec/errors/invalid-response-data-error.ts b/...ion/errors/invalid-response-data-error.ts → ...pec/errors/invalid-response-data-error.ts
diff --git a/...on/errors/invalid-tool-arguments-error.ts → ...ec/errors/invalid-tool-arguments-error.ts b/...on/errors/invalid-tool-arguments-error.ts → ...ec/errors/invalid-tool-arguments-error.ts
diff --git a/...-specification/errors/json-parse-error.ts → ...ages/core/spec/errors/json-parse-error.ts b/...-specification/errors/json-parse-error.ts → ...ages/core/spec/errors/json-parse-error.ts
diff --git a/...pecification/errors/load-api-key-error.ts → ...es/core/spec/errors/load-api-key-error.ts b/...pecification/errors/load-api-key-error.ts → ...es/core/spec/errors/load-api-key-error.ts
diff --git a/...ation/errors/no-object-generated-error.ts → .../spec/errors/no-object-generated-error.ts b/...ation/errors/no-object-generated-error.ts → .../spec/errors/no-object-generated-error.ts
diff --git a/...fication/errors/no-response-body-error.ts → ...ore/spec/errors/no-response-body-error.ts b/...fication/errors/no-response-body-error.ts → ...ore/spec/errors/no-response-body-error.ts
diff --git a/...pecification/errors/no-such-tool-error.ts → ...es/core/spec/errors/no-such-tool-error.ts b/...pecification/errors/no-such-tool-error.ts → ...es/core/spec/errors/no-such-tool-error.ts
diff --git a/...model-specification/errors/retry-error.ts → packages/core/spec/errors/retry-error.ts b/...model-specification/errors/retry-error.ts → packages/core/spec/errors/retry-error.ts
diff --git a/...ification/errors/type-validation-error.ts → ...core/spec/errors/type-validation-error.ts b/...ification/errors/type-validation-error.ts → ...core/spec/errors/type-validation-error.ts
diff --git a/...errors/unsupported-functionality-error.ts → ...errors/unsupported-functionality-error.ts b/...errors/unsupported-functionality-error.ts → ...errors/unsupported-functionality-error.ts
diff --git a/...ages/core/ai-model-specification/index.ts → packages/core/spec/index.ts b/...ages/core/ai-model-specification/index.ts → packages/core/spec/index.ts
diff --git a/...del-specification/language-model/index.ts → packages/core/spec/language-model/index.ts b/...del-specification/language-model/index.ts → packages/core/spec/language-model/index.ts
diff --git a/...-specification/language-model/v1/index.ts → ...ages/core/spec/language-model/v1/index.ts b/...-specification/language-model/v1/index.ts → ...ages/core/spec/language-model/v1/index.ts
diff --git a/...odel/v1/language-model-v1-call-options.ts → ...odel/v1/language-model-v1-call-options.ts b/...odel/v1/language-model-v1-call-options.ts → ...odel/v1/language-model-v1-call-options.ts
diff --git a/...del/v1/language-model-v1-call-settings.ts → ...del/v1/language-model-v1-call-settings.ts b/...del/v1/language-model-v1-call-settings.ts → ...del/v1/language-model-v1-call-settings.ts
diff --git a/...odel/v1/language-model-v1-call-warning.ts → ...odel/v1/language-model-v1-call-warning.ts b/...odel/v1/language-model-v1-call-warning.ts → ...odel/v1/language-model-v1-call-warning.ts
diff --git a/...del/v1/language-model-v1-finish-reason.ts → ...del/v1/language-model-v1-finish-reason.ts b/...del/v1/language-model-v1-finish-reason.ts → ...del/v1/language-model-v1-finish-reason.ts
diff --git a/...1/language-model-v1-function-tool-call.ts → ...1/language-model-v1-function-tool-call.ts b/...1/language-model-v1-function-tool-call.ts → ...1/language-model-v1-function-tool-call.ts
diff --git a/...del/v1/language-model-v1-function-tool.ts → ...del/v1/language-model-v1-function-tool.ts b/...del/v1/language-model-v1-function-tool.ts → ...del/v1/language-model-v1-function-tool.ts
diff --git a/...uage-model/v1/language-model-v1-prompt.ts → ...uage-model/v1/language-model-v1-prompt.ts b/...uage-model/v1/language-model-v1-prompt.ts → ...uage-model/v1/language-model-v1-prompt.ts
diff --git a/...on/language-model/v1/language-model-v1.ts → ...ec/language-model/v1/language-model-v1.ts b/...on/language-model/v1/language-model-v1.ts → ...ec/language-model/v1/language-model-v1.ts
@@ -3,6 +3,10 @@ import { LanguageModelV1CallWarning } from './language-model-v1-call-warning';
 import { LanguageModelV1FinishReason } from './language-model-v1-finish-reason';
 import { LanguageModelV1FunctionToolCall } from './language-model-v1-function-tool-call';
 
+/**
+ * Experimental: Specification for a language model that implements the language model
+ * interface version 1.
+ */
 export type LanguageModelV1 = {
   /**
    * The language model must specify which language model interface

diff --git a/...ification/test/convert-stream-to-array.ts → ...core/spec/test/convert-stream-to-array.ts b/...ification/test/convert-stream-to-array.ts → ...core/spec/test/convert-stream-to-array.ts
diff --git a/...el-specification/test/json-test-server.ts → packages/core/spec/test/json-test-server.ts b/...el-specification/test/json-test-server.ts → packages/core/spec/test/json-test-server.ts
diff --git a/...ecification/test/streaming-test-server.ts → ...s/core/spec/test/streaming-test-server.ts b/...ecification/test/streaming-test-server.ts → ...s/core/spec/test/streaming-test-server.ts
diff --git a/...i-model-specification/util/generate-id.ts → packages/core/spec/util/generate-id.ts b/...i-model-specification/util/generate-id.ts → packages/core/spec/util/generate-id.ts
diff --git a/...l-specification/util/get-error-message.ts → packages/core/spec/util/get-error-message.ts b/...l-specification/util/get-error-message.ts → packages/core/spec/util/get-error-message.ts
diff --git a/...core/ai-model-specification/util/index.ts → packages/core/spec/util/index.ts b/...core/ai-model-specification/util/index.ts → packages/core/spec/util/index.ts
diff --git a/...i-model-specification/util/json-schema.ts → packages/core/spec/util/json-schema.ts b/...i-model-specification/util/json-schema.ts → packages/core/spec/util/json-schema.ts
diff --git a/...-model-specification/util/load-api-key.ts → packages/core/spec/util/load-api-key.ts b/...-model-specification/util/load-api-key.ts → packages/core/spec/util/load-api-key.ts
diff --git a/...ai-model-specification/util/parse-json.ts → packages/core/spec/util/parse-json.ts b/...ai-model-specification/util/parse-json.ts → packages/core/spec/util/parse-json.ts
diff --git a/...i-model-specification/util/post-to-api.ts → packages/core/spec/util/post-to-api.ts b/...i-model-specification/util/post-to-api.ts → packages/core/spec/util/post-to-api.ts
diff --git a/...el-specification/util/response-handler.ts → packages/core/spec/util/response-handler.ts b/...el-specification/util/response-handler.ts → packages/core/spec/util/response-handler.ts
diff --git a/...core/ai-model-specification/util/scale.ts → packages/core/spec/util/scale.ts b/...core/ai-model-specification/util/scale.ts → packages/core/spec/util/scale.ts
diff --git a/...i-model-specification/util/uint8-utils.ts → packages/core/spec/util/uint8-utils.ts b/...i-model-specification/util/uint8-utils.ts → packages/core/spec/util/uint8-utils.ts
diff --git a/...odel-specification/util/validate-types.ts → packages/core/spec/util/validate-types.ts b/...odel-specification/util/validate-types.ts → packages/core/spec/util/validate-types.ts
diff --git a/packages/core/tsup.config.ts b/packages/core/tsup.config.ts
@@ -121,9 +121,9 @@ export default defineConfig([
   },
   // AI Core: Model Specification
   {
-    entry: ['ai-model-specification/index.ts'],
+    entry: ['spec/index.ts'],
     format: ['cjs', 'esm'],
-    outDir: 'ai-model-specification/dist',
+    outDir: 'spec/dist',
     dts: true,
     sourcemap: true,
   },