@prompt-foundry/typescript-sdk - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

CHANGELOG.md

 # Changelog
 
+## 1.7.0 (2024-06-18)
+
+Full Changelog: [v1.6.0...v1.7.0](https://github.com/prompt-foundry/typescript-sdk/compare/v1.6.0...v1.7.0)
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#53](https://github.com/prompt-foundry/typescript-sdk/issues/53)) ([174926c](https://github.com/prompt-foundry/typescript-sdk/commit/174926cb3dba936b5bc1345e653dea8f18eeee9e))
+* **api:** OpenAPI spec update via Stainless API ([#54](https://github.com/prompt-foundry/typescript-sdk/issues/54)) ([bebca91](https://github.com/prompt-foundry/typescript-sdk/commit/bebca9122a833f73fd586aa1d682d6181eaf8142))
+
 ## 1.6.0 (2024-06-16)
@@ -4,0 +13,0 @@

package.json

 {
   "name": "@prompt-foundry/typescript-sdk",
-  "version": "1.6.0",
-  "description": "The official TypeScript library for the Prompt Foundry API",
+  "version": "1.7.0",
+  "description": "The prompt engineering, prompt management, and prompt evaluation tool for TypeScript, JavaScript, and NodeJS.",
+  "keywords": [
+    "typescript",
+    "javascript",
+    "nodejs",
+    "sdk",
+    "prompt",
+    "prompt-engineering",
+    "prompt-management",
+    "prompt-testing",
+    "openai"
+  ],
   "author": "Prompt Foundry <[e-mail]>",
@@ -6,0 +17,0 @@ "types": "./index.d.ts",

resources/evaluation-assertions.d.ts

@@ -30,18 +30,18 @@ import * as Core from '@prompt-foundry/typescript-sdk/core';
     evaluationId: string;
-    matcher: EvaluationAssertion.Matcher;
-    target: string;
+    /**
+     * A JSON path to use when matching the response. Only required when type is
+     * `JSON_EXACT_MATCH` or `JSON_CONTAINS`.
+     */
+    jsonPath: string | null;
+    targetValue: string;
+    /**
+     * The name of the tool to match. Only required when type is `TOOL_CALLED` or
+     * `TOOL_CALLED_WITH`.
+     */
+    toolName: string | null;
+    /**
+     * The type of evaluation matcher to use.
+     */
+    type: 'EXACT_MATCH' | 'CONTAINS' | 'JSON_EXACT_MATCH' | 'JSON_CONTAINS' | 'TOOL_CALLED' | 'TOOL_CALLED_WITH';
 }
-export declare namespace EvaluationAssertion {
-    interface Matcher {
-        /**
-         * A JSON path to use when matching the response. Only required when type is
-         * `jsonPath`.
-         */
-        jsonPath: string | null;
-        /**
-         * The type of evaluation matcher to use.
-         */
-        type: 'CONTAINS' | 'EQUALS' | 'JSON';
-    }
-}
 export type EvaluationAssertionListResponse = Array<EvaluationAssertion>;
@@ -53,36 +53,36 @@ export interface EvaluationAssertionDeleteResponse {
     evaluationId: string;
-    matcher: EvaluationAssertionCreateParams.Matcher;
-    target: string;
+    /**
+     * A JSON path to use when matching the response. Only required when type is
+     * `JSON_EXACT_MATCH` or `JSON_CONTAINS`.
+     */
+    jsonPath: string | null;
+    targetValue: string;
+    /**
+     * The name of the tool to match. Only required when type is `TOOL_CALLED` or
+     * `TOOL_CALLED_WITH`.
+     */
+    toolName: string | null;
+    /**
+     * The type of evaluation matcher to use.
+     */
+    type: 'EXACT_MATCH' | 'CONTAINS' | 'JSON_EXACT_MATCH' | 'JSON_CONTAINS' | 'TOOL_CALLED' | 'TOOL_CALLED_WITH';
 }
-export declare namespace EvaluationAssertionCreateParams {
-    interface Matcher {
-        /**
-         * A JSON path to use when matching the response. Only required when type is
-         * `jsonPath`.
-         */
-        jsonPath: string | null;
-        /**
-         * The type of evaluation matcher to use.
-         */
-        type: 'CONTAINS' | 'EQUALS' | 'JSON';
-    }
-}
 export interface EvaluationAssertionUpdateParams {
     evaluationId: string;
-    matcher: EvaluationAssertionUpdateParams.Matcher;
-    target: string;
+    /**
+     * A JSON path to use when matching the response. Only required when type is
+     * `JSON_EXACT_MATCH` or `JSON_CONTAINS`.
+     */
+    jsonPath: string | null;
+    targetValue: string;
+    /**
+     * The name of the tool to match. Only required when type is `TOOL_CALLED` or
+     * `TOOL_CALLED_WITH`.
+     */
+    toolName: string | null;
+    /**
+     * The type of evaluation matcher to use.
+     */
+    type: 'EXACT_MATCH' | 'CONTAINS' | 'JSON_EXACT_MATCH' | 'JSON_CONTAINS' | 'TOOL_CALLED' | 'TOOL_CALLED_WITH';
 }
-export declare namespace EvaluationAssertionUpdateParams {
-    interface Matcher {
-        /**
-         * A JSON path to use when matching the response. Only required when type is
-         * `jsonPath`.
-         */
-        jsonPath: string | null;
-        /**
-         * The type of evaluation matcher to use.
-         */
-        type: 'CONTAINS' | 'EQUALS' | 'JSON';
-    }
-}
 export interface EvaluationAssertionListParams {
@@ -89,0 +89,0 @@ /**

src/resources/evaluation-assertions.ts

@@ -68,20 +68,26 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-  matcher: EvaluationAssertion.Matcher;
+  /**
+   * A JSON path to use when matching the response. Only required when type is
+   * `JSON_EXACT_MATCH` or `JSON_CONTAINS`.
+   */
+  jsonPath: string | null;
 
-  target: string;
-}
+  targetValue: string;
 
-export namespace EvaluationAssertion {
-  export interface Matcher {
-    /**
-     * A JSON path to use when matching the response. Only required when type is
-     * `jsonPath`.
-     */
-    jsonPath: string | null;
+  /**
+   * The name of the tool to match. Only required when type is `TOOL_CALLED` or
+   * `TOOL_CALLED_WITH`.
+   */
+  toolName: string | null;
 
-    /**
-     * The type of evaluation matcher to use.
-     */
-    type: 'CONTAINS' | 'EQUALS' | 'JSON';
-  }
+  /**
+   * The type of evaluation matcher to use.
+   */
+  type:
+    | 'EXACT_MATCH'
+    | 'CONTAINS'
+    | 'JSON_EXACT_MATCH'
+    | 'JSON_CONTAINS'
+    | 'TOOL_CALLED'
+    | 'TOOL_CALLED_WITH';
 }
@@ -98,20 +104,26 @@
 
-  matcher: EvaluationAssertionCreateParams.Matcher;
+  /**
+   * A JSON path to use when matching the response. Only required when type is
+   * `JSON_EXACT_MATCH` or `JSON_CONTAINS`.
+   */
+  jsonPath: string | null;
 
-  target: string;
-}
+  targetValue: string;
 
-export namespace EvaluationAssertionCreateParams {
-  export interface Matcher {
-    /**
-     * A JSON path to use when matching the response. Only required when type is
-     * `jsonPath`.
-     */
-    jsonPath: string | null;
+  /**
+   * The name of the tool to match. Only required when type is `TOOL_CALLED` or
+   * `TOOL_CALLED_WITH`.
+   */
+  toolName: string | null;
 
-    /**
-     * The type of evaluation matcher to use.
-     */
-    type: 'CONTAINS' | 'EQUALS' | 'JSON';
-  }
+  /**
+   * The type of evaluation matcher to use.
+   */
+  type:
+    | 'EXACT_MATCH'
+    | 'CONTAINS'
+    | 'JSON_EXACT_MATCH'
+    | 'JSON_CONTAINS'
+    | 'TOOL_CALLED'
+    | 'TOOL_CALLED_WITH';
 }
@@ -122,20 +134,26 @@
 
-  matcher: EvaluationAssertionUpdateParams.Matcher;
+  /**
+   * A JSON path to use when matching the response. Only required when type is
+   * `JSON_EXACT_MATCH` or `JSON_CONTAINS`.
+   */
+  jsonPath: string | null;
 
-  target: string;
-}
+  targetValue: string;
 
-export namespace EvaluationAssertionUpdateParams {
-  export interface Matcher {
-    /**
-     * A JSON path to use when matching the response. Only required when type is
-     * `jsonPath`.
-     */
-    jsonPath: string | null;
+  /**
+   * The name of the tool to match. Only required when type is `TOOL_CALLED` or
+   * `TOOL_CALLED_WITH`.
+   */
+  toolName: string | null;
 
-    /**
-     * The type of evaluation matcher to use.
-     */
-    type: 'CONTAINS' | 'EQUALS' | 'JSON';
-  }
+  /**
+   * The type of evaluation matcher to use.
+   */
+  type:
+    | 'EXACT_MATCH'
+    | 'CONTAINS'
+    | 'JSON_EXACT_MATCH'
+    | 'JSON_CONTAINS'
+    | 'TOOL_CALLED'
+    | 'TOOL_CALLED_WITH';
 }
@@ -142,0 +160,0 @@

src/version.ts

@@ -1,1 +0,1 @@
-export const VERSION = '1.6.0'; // x-release-please-version
+export const VERSION = '1.7.0'; // x-release-please-version

version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "1.6.0";
+export declare const VERSION = "1.7.0";
 //# sourceMappingURL=version.d.ts.map

version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.6.0'; // x-release-please-version
+exports.VERSION = '1.7.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

No alert changes

Improved metrics

Total package byte prevSize

519465

increased by0.28%

Lines of code

8638

increased by0.21%

No dependency changes