vellum-ai 0.0.3 → 0.0.6

package/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { Vellum } from ".";
+import * as Vellum from "./api";
 import { Documents } from "./api/resources/documents/client/Client";
 import { ModelVersions } from "./api/resources/modelVersions/client/Client";
 export declare namespace VellumClient {

package/README.md

@@ -5,6 +5,9 @@
 
 The Vellum Node.js library provides access to the Vellum API from JavaScript/TypeScript.
 
+## API Docs
+You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai).
+
 
 ## Installation
 
@@ -19,7 +22,7 @@ yarn add vellum-ai
 [![Try it out](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/typescript-example-using-sdk-built-with-fern-xbs4jx?file=app.ts)
 
 ```typescript
-import { VellumClient } from '@fern-api/vellum';
+import { VellumClient } from 'vellum-ai';
 
 const vellum = new VellumClient({
   apiKey: 'VELLUM_API_KEY',
@@ -39,7 +42,7 @@ Documents can be uploaded to Vellum via either the UI or this API. Once uploaded
 ```typescript
 import * as fs from 'fs';
 
-await vellum.document.upload(fs.createReadStream('/path/to/your/file.txt'), {
+await vellum.documents.upload(fs.createReadStream('/path/to/your/file.txt'), {
   addToIndexNames: ['<your-index-name>'],
   externalId: '<your-external-id>',
   label: 'Human-friendly label for your document',

package/api/client/requests/GenerateBodyRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../../..";
+import * as Vellum from "../..";
 export interface GenerateBodyRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

package/api/client/requests/SearchRequestBodyRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../../..";
+import * as Vellum from "../..";
 export interface SearchRequestBodyRequest {
     /** The ID of the index to search against. Must provide either this or index_name. */
     indexId?: string;

package/api/client/requests/SubmitCompletionActualsRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../../..";
+import * as Vellum from "../..";
 export interface SubmitCompletionActualsRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

package/api/resources/documents/client/Client.d.ts

@@ -4,7 +4,7 @@
 /// <reference types="node" />
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import { Vellum } from "../../../..";
+import * as Vellum from "../../..";
 import * as fs from "fs";
 export declare namespace Documents {
     interface Options {

package/api/resources/documents/client/Client.js

@@ -95,14 +95,20 @@ class Documents {
     }
     async upload(contents, request) {
         const _request = new form_data_1.default();
-        for (const _item of request.addToIndexNames) {
-            _request.append("add_to_index_names", _item);
+        if (request.addToIndexNames != null) {
+            for (const _item of request.addToIndexNames) {
+                _request.append("add_to_index_names", _item);
+            }
+        }
+        if (request.externalId != null) {
+            _request.append("external_id", request.externalId);
         }
-        _request.append("external_id", request.externalId);
         _request.append("label", request.label);
         _request.append("contents", contents);
-        for (const _item of request.keywords) {
-            _request.append("keywords", _item);
+        if (request.keywords != null) {
+            for (const _item of request.keywords) {
+                _request.append("keywords", _item);
+            }
         }
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).documents, "v1/upload-document"),

package/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts

@@ -3,11 +3,11 @@
  */
 export interface UploadDocumentBodyRequest {
     /** Optionally include the names of all indexes that you'd like this document to be included in */
-    addToIndexNames: string[];
+    addToIndexNames?: string[];
     /** Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed. */
-    externalId: string;
+    externalId?: string;
     /** A human-friendly name for this document. Typically the filename. */
     label: string;
     /** Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches. */
-    keywords: string[];
+    keywords?: string[];
 }

package/api/resources/modelVersions/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import { Vellum } from "../../../..";
+import * as Vellum from "../../..";
 export declare namespace ModelVersions {
     interface Options {
         environment?: environments.VellumEnvironment | environments.VellumEnvironmentUrls;

package/api/types/ChatMessageRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ChatMessageRequest {
+    text: string;
+    role: Vellum.ChatMessageRole;
+}

package/api/types/ChatMessageRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/{ChatRoleEnum.d.ts → ChatMessageRole.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ChatRoleEnum = "SYSTEM" | "ASSISTANT" | "USER";
-export declare const ChatRoleEnum: {
+export declare type ChatMessageRole = "SYSTEM" | "ASSISTANT" | "USER";
+export declare const ChatMessageRole: {
     readonly System: "SYSTEM";
     readonly Assistant: "ASSISTANT";
     readonly User: "USER";

package/api/types/{ChatRoleEnum.js → ChatMessageRole.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatRoleEnum = void 0;
-exports.ChatRoleEnum = {
+exports.ChatMessageRole = void 0;
+exports.ChatMessageRole = {
     System: "SYSTEM",
     Assistant: "ASSISTANT",
     User: "USER",

package/api/types/DocumentDocumentToDocumentIndex.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface DocumentDocumentToDocumentIndex {
     /** Vellum-generated ID that uniquely identifies this link. */
     id: string;

package/api/types/EnrichedNormalizedCompletion.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface EnrichedNormalizedCompletion {
     /** The Vellum-generated ID of the completion. */
     id: string;
@@ -10,7 +10,7 @@ export interface EnrichedNormalizedCompletion {
     /** The text generated by the LLM. */
     text: string;
     /** The reason the generation finished. */
-    finishReason: Vellum.FinishReasonEnum;
+    finishReason?: Vellum.FinishReasonEnum;
     /** The logprobs of the completion. Only present if specified in the original request options. */
     logprobs?: Vellum.NormalizedLogProbs;
     /** The ID of the model version used to generate this completion. */

package/api/types/GenerateOptionsRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface GenerateOptionsRequest {
     /** Which logprobs to include, if any. Defaults to NONE. */
     logprobs?: Vellum.LogprobsEnum;

package/api/types/GenerateRequest.d.ts

@@ -1,9 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Vellum from "..";
 export interface GenerateRequest {
     /** Key/value pairs for each template variable defined in the deployment's prompt. */
     inputValues: Record<string, unknown>;
+    /** Optionally provide a list of chat messages that'll be used in place of the special {$chat_history} variable, if included in the prompt. */
+    chatHistory?: Vellum.ChatMessageRequest[];
     /** Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one. */
     externalIds?: string[];
 }

package/api/types/GenerateResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface GenerateResponse {
     /** The results of each generation request. */
     results: Vellum.GenerateResult[];

package/api/types/GenerateResult.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface GenerateResult {
     /** An object containing the resulting generation. This key will be absent if the LLM provider experienced an error. */
     data?: Vellum.GenerateResultData;

package/api/types/GenerateResultData.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface GenerateResultData {
     /** The generated completions. This will generally be a list of length one. */
     completions: Vellum.EnrichedNormalizedCompletion[];

package/api/types/ModelVersionBuildConfig.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface ModelVersionBuildConfig {
     /** The name of the base model used to create this model version, as identified by the LLM provider. */
     baseModel: string;

package/api/types/ModelVersionExecConfigParameters.d.ts

@@ -4,7 +4,7 @@
 export interface ModelVersionExecConfigParameters {
     temperature: number;
     maxTokens: number;
-    stop: string[];
+    stop?: string[];
     topP: number;
     topK?: number;
     frequencyPenalty: number;

package/api/types/ModelVersionExecConfigRead.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface ModelVersionExecConfigRead {
     /** The generation parameters that are passed to the LLM provider at runtime. */
     parameters: Vellum.ModelVersionExecConfigParameters;

package/api/types/ModelVersionRead.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface ModelVersionRead {
     /** Vellum-generated ID that uniquely identifies this model version. */
     id: string;

package/api/types/NormalizedLogProbs.d.ts

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface NormalizedLogProbs {
     tokens: Vellum.NormalizedTokenLogProbs[];
-    likelihood: number;
+    likelihood?: number;
 }

package/api/types/NormalizedTokenLogProbs.d.ts

@@ -3,7 +3,7 @@
  */
 export interface NormalizedTokenLogProbs {
     token: string;
-    logprob: number;
-    topLogprobs: Record<string, number>;
+    logprob?: number;
+    topLogprobs?: Record<string, number | undefined>;
     textOffset: number;
 }

package/api/types/PaginatedSlimDocumentList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface PaginatedSlimDocumentList {
     count?: number;
     next?: string;

package/api/types/PromptTemplateBlock.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface PromptTemplateBlock {
     blockType: Vellum.BlockTypeEnum;
     properties: Vellum.PromptTemplateBlockProperties;

package/api/types/PromptTemplateBlockData.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface PromptTemplateBlockData {
     version: number;
     blocks: Vellum.PromptTemplateBlock[];

package/api/types/PromptTemplateBlockProperties.d.ts

@@ -1,9 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface PromptTemplateBlockProperties {
-    chatRole?: Vellum.ChatRoleEnum;
+    chatRole?: Vellum.ChatMessageRole;
     text?: string;
     variableName?: string;
     blocks?: Record<string, unknown>[];

package/api/types/SearchRequestOptionsRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface SearchRequestOptionsRequest {
     /** The maximum number of results to return. */
     limit?: number;

package/api/types/SearchResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface SearchResponse {
     /** The results of the search. Each result represents a chunk that matches the search query. */
     results: Vellum.SearchResult[];

package/api/types/SearchResult.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface SearchResult {
     /** The document that contains the chunk that matched the search query. */
     document: Vellum.Document;

package/api/types/SlimDocument.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface SlimDocument {
     /** Vellum-generated ID that uniquely identifies this document. */
     id: string;

package/api/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./BlockTypeEnum";
-export * from "./ChatRoleEnum";
+export * from "./ChatMessageRequest";
+export * from "./ChatMessageRole";
 export * from "./Document";
 export * from "./DocumentDocumentToDocumentIndex";
 export * from "./EnrichedNormalizedCompletion";

package/api/types/index.js

@@ -15,7 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BlockTypeEnum"), exports);
-__exportStar(require("./ChatRoleEnum"), exports);
+__exportStar(require("./ChatMessageRequest"), exports);
+__exportStar(require("./ChatMessageRole"), exports);
 __exportStar(require("./Document"), exports);
 __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
 __exportStar(require("./EnrichedNormalizedCompletion"), exports);

package/core/fetcher/Fetcher.js

@@ -26,7 +26,7 @@ const fetcher = async (args) => {
             data: args.body,
             validateStatus: () => true,
             transformResponse: (response) => response,
-            timeout: args.timeoutMs ?? 60_000,
+            timeout: args.timeoutMs,
             transitional: {
                 clarifyTimeoutError: true,
             },

package/dist/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { Vellum } from ".";
+import * as Vellum from "./api";
 import { Documents } from "./api/resources/documents/client/Client";
 import { ModelVersions } from "./api/resources/modelVersions/client/Client";
 export declare namespace VellumClient {

package/dist/api/client/requests/GenerateBodyRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../../..";
+import * as Vellum from "../..";
 export interface GenerateBodyRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

package/dist/api/client/requests/SearchRequestBodyRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../../..";
+import * as Vellum from "../..";
 export interface SearchRequestBodyRequest {
     /** The ID of the index to search against. Must provide either this or index_name. */
     indexId?: string;

package/dist/api/client/requests/SubmitCompletionActualsRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../../..";
+import * as Vellum from "../..";
 export interface SubmitCompletionActualsRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

package/dist/api/resources/documents/client/Client.d.ts

@@ -4,7 +4,7 @@
 /// <reference types="node" />
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import { Vellum } from "../../../..";
+import * as Vellum from "../../..";
 import * as fs from "fs";
 export declare namespace Documents {
     interface Options {

package/dist/api/resources/documents/client/Client.js

@@ -95,14 +95,20 @@ class Documents {
     }
     async upload(contents, request) {
         const _request = new form_data_1.default();
-        for (const _item of request.addToIndexNames) {
-            _request.append("add_to_index_names", _item);
+        if (request.addToIndexNames != null) {
+            for (const _item of request.addToIndexNames) {
+                _request.append("add_to_index_names", _item);
+            }
+        }
+        if (request.externalId != null) {
+            _request.append("external_id", request.externalId);
         }
-        _request.append("external_id", request.externalId);
         _request.append("label", request.label);
         _request.append("contents", contents);
-        for (const _item of request.keywords) {
-            _request.append("keywords", _item);
+        if (request.keywords != null) {
+            for (const _item of request.keywords) {
+                _request.append("keywords", _item);
+            }
         }
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).documents, "v1/upload-document"),

package/dist/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts

@@ -3,11 +3,11 @@
  */
 export interface UploadDocumentBodyRequest {
     /** Optionally include the names of all indexes that you'd like this document to be included in */
-    addToIndexNames: string[];
+    addToIndexNames?: string[];
     /** Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed. */
-    externalId: string;
+    externalId?: string;
     /** A human-friendly name for this document. Typically the filename. */
     label: string;
     /** Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches. */
-    keywords: string[];
+    keywords?: string[];
 }

package/dist/api/resources/modelVersions/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import { Vellum } from "../../../..";
+import * as Vellum from "../../..";
 export declare namespace ModelVersions {
     interface Options {
         environment?: environments.VellumEnvironment | environments.VellumEnvironmentUrls;

package/dist/api/types/ChatMessageRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ChatMessageRequest {
+    text: string;
+    role: Vellum.ChatMessageRole;
+}

package/dist/api/types/ChatMessageRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/{ChatRoleEnum.d.ts → ChatMessageRole.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ChatRoleEnum = "SYSTEM" | "ASSISTANT" | "USER";
-export declare const ChatRoleEnum: {
+export declare type ChatMessageRole = "SYSTEM" | "ASSISTANT" | "USER";
+export declare const ChatMessageRole: {
     readonly System: "SYSTEM";
     readonly Assistant: "ASSISTANT";
     readonly User: "USER";

package/dist/api/types/{ChatRoleEnum.js → ChatMessageRole.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatRoleEnum = void 0;
-exports.ChatRoleEnum = {
+exports.ChatMessageRole = void 0;
+exports.ChatMessageRole = {
     System: "SYSTEM",
     Assistant: "ASSISTANT",
     User: "USER",

package/dist/api/types/DocumentDocumentToDocumentIndex.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface DocumentDocumentToDocumentIndex {
     /** Vellum-generated ID that uniquely identifies this link. */
     id: string;

package/dist/api/types/EnrichedNormalizedCompletion.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface EnrichedNormalizedCompletion {
     /** The Vellum-generated ID of the completion. */
     id: string;
@@ -10,7 +10,7 @@ export interface EnrichedNormalizedCompletion {
     /** The text generated by the LLM. */
     text: string;
     /** The reason the generation finished. */
-    finishReason: Vellum.FinishReasonEnum;
+    finishReason?: Vellum.FinishReasonEnum;
     /** The logprobs of the completion. Only present if specified in the original request options. */
     logprobs?: Vellum.NormalizedLogProbs;
     /** The ID of the model version used to generate this completion. */

package/dist/api/types/GenerateOptionsRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { Vellum } from "../..";
+import * as Vellum from "..";
 export interface GenerateOptionsRequest {
     /** Which logprobs to include, if any. Defaults to NONE. */
     logprobs?: Vellum.LogprobsEnum;