llama-stack-client 0.4.4 → 0.4.5

package/dist/resources/safety.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safety.d.ts","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,KAAK,CACX,qBAAqB,CAAC,2BAA2B,GACjD,qBAAqB,CAAC,wBAAwB,GAC9C,qBAAqB,CAAC,gCAAgC,GACtD,qBAAqB,CAAC,sBAAsB,GAC5C,qBAAqB,CAAC,2BAA2B,CACpD,CAAC;IAEF,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C,OAAO,EACH,MAAM,GACN,KAAK,CACD,2BAA2B,CAAC,wCAAwC,GACpE,2BAA2B,CAAC,yCAAyC,GACrE,2BAA2B,CAAC,UAAU,CACzC,CAAC;QAEN,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,wCAAwC;YACvD,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,yCAAyC;YACxD;;eAEG;YACH,SAAS,EAAE,yCAAyC,CAAC,QAAQ,CAAC;YAE9D,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB;QAED,UAAiB,yCAAyC,CAAC;YACzD;;eAEG;YACH,UAAiB,QAAQ;gBACvB,GAAG,EAAE,MAAM,CAAC;gBAEZ,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACxB;SACF;QAED,UAAiB,UAAU;YACzB,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,IAAI;gBACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAExB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aAC1B;SACF;KACF;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,wBAAwB,CAAC,4CAA4C,CAAC,CAAC;QAE/F,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED,UAAiB,wBAAwB,CAAC;QACxC;;WAEG;QACH,UAAiB,4CAA4C;YAC3D,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;;OAGG;IACH,UAAiB,gCAAgC;QAC/C,OAAO,CAAC,EACJ,MAAM,GACN,KAAK,CAAC,gCAAgC,CAAC,4CAA4C,CAAC,GACpF,IAAI,CAAC;QAET,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;KACtE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,4CAA4C;YAC3D,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEpC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE,UAAU,CAAC;SACnB;QAED,UAAiB,QAAQ,CAAC;YACxB;;eAEG;YACH,UAAiB,QAAQ;gBACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACtB;SACF;KACF;IAED;;;OAGG;IACH,UAAiB,sBAAsB;QACrC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,sBAAsB,CAAC,4CAA4C,CAAC,CAAC;QAE7F,YAAY,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,sBAAsB,CAAC;QACtC;;WAEG;QACH,UAAiB,4CAA4C;YAC3D,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,2BAA2B;QAC1C,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,2BAA2B,CAAC,4CAA4C,CAAC,CAAC;QAElG,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,WAAW,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,4CAA4C;YAC3D,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAC7G"}
+{"version":3,"file":"safety.d.ts","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,KAAK,CACX,qBAAqB,CAAC,2BAA2B,GACjD,qBAAqB,CAAC,wBAAwB,GAC9C,qBAAqB,CAAC,gCAAgC,GACtD,qBAAqB,CAAC,sBAAsB,GAC5C,qBAAqB,CAAC,2BAA2B,CACpD,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,OAAO,EACH,MAAM,GACN,KAAK,CACD,2BAA2B,CAAC,wCAAwC,GACpE,2BAA2B,CAAC,yCAAyC,GACrE,2BAA2B,CAAC,UAAU,CACzC,CAAC;QAEN;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,wCAAwC;YACvD;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,yCAAyC;YACxD;;eAEG;YACH,SAAS,EAAE,yCAAyC,CAAC,QAAQ,CAAC;YAE9D;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB;QAED,UAAiB,yCAAyC,CAAC;YACzD;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;aACzC;SACF;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;YAEtB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU,CAAC;YAC1B;;eAEG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAExB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aAC1B;SACF;KACF;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,wBAAwB,CAAC,4CAA4C,CAAC,CAAC;QAE/F;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED,UAAiB,wBAAwB,CAAC;QACxC;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;;OAGG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,OAAO,CAAC,EACJ,MAAM,GACN,KAAK,CAAC,gCAAgC,CAAC,4CAA4C,CAAC,GACpF,IAAI,CAAC;QAET;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;KACtE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEpC;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,IAAI,CAAC,EAAE,UAAU,CAAC;SACnB;QAED,UAAiB,QAAQ,CAAC;YACxB;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACtB;SACF;KACF;IAED;;;OAGG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,sBAAsB,CAAC,4CAA4C,CAAC,CAAC;QAE7F;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,sBAAsB,CAAC;QACtC;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,2BAA2B,CAAC,4CAA4C,CAAC,CAAC;QAElG;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAC7G"}

package/dist/resources/safety.js

@@ -11,9 +11,7 @@ exports.Safety = void 0;
 const resource_1 = require("../resource.js");
 class Safety extends resource_1.APIResource {
     /**
-     * Run shield.
-     *
-     * Run a shield.
+     * Run a safety shield on messages to check for policy violations.
      */
     runShield(body, options) {
         return this._client.post('/v1/safety/run-shield', { body, ...options });

package/dist/resources/safety.js.map

@@ -1 +1 @@
-{"version":3,"file":"safety.js","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":";AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;;;AAEtF,6CAA0C;AAI1C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;OAIG;IACH,SAAS,CAAC,IAA2B,EAAE,OAA6B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AATD,wBASC"}
+{"version":3,"file":"safety.js","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":";AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;;;AAEtF,6CAA0C;AAI1C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,SAAS,CAAC,IAA2B,EAAE,OAA6B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAPD,wBAOC"}

package/dist/resources/safety.mjs

@@ -8,9 +8,7 @@
 import { APIResource } from "../resource.mjs";
 export class Safety extends APIResource {
     /**
-     * Run shield.
-     *
-     * Run a shield.
+     * Run a safety shield on messages to check for policy violations.
      */
     runShield(body, options) {
         return this._client.post('/v1/safety/run-shield', { body, ...options });

package/dist/resources/safety.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"safety.mjs","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,SAAS,CAAC,IAA2B,EAAE,OAA6B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}
+{"version":3,"file":"safety.mjs","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,SAAS,CAAC,IAA2B,EAAE,OAA6B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/dist/resources/scoring-functions.d.ts

@@ -22,7 +22,13 @@ export declare class ScoringFunctions extends APIResource {
      */
     unregister(scoringFnId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
 }
+/**
+ * Response containing a list of scoring function objects.
+ */
 export interface ListScoringFunctionsResponse {
+    /**
+     * List of scoring function objects.
+     */
     data: ScoringFunctionListResponse;
 }
 /**
@@ -147,16 +153,32 @@ export declare namespace ScoringFnParams {
         type?: 'basic';
     }
 }
+/**
+ * List of scoring function objects.
+ */
 export type ScoringFunctionListResponse = Array<ScoringFn>;
 export interface ScoringFunctionRegisterParams {
+    /**
+     * The description of the scoring function.
+     */
     description: string;
     return_type: ScoringFunctionRegisterParams.ReturnType;
+    /**
+     * The ID of the scoring function to register.
+     */
     scoring_fn_id: string;
     /**
-     * Parameters for LLM-as-judge scoring function configuration.
+     * The parameters for the scoring function for benchmark eval, these can be
+     * overridden for app eval.
      */
     params?: ScoringFunctionRegisterParams.LlmAsJudgeScoringFnParams | ScoringFunctionRegisterParams.RegexParserScoringFnParams | ScoringFunctionRegisterParams.BasicScoringFnParams | null;
+    /**
+     * The ID of the provider to use for the scoring function.
+     */
     provider_id?: string | null;
+    /**
+     * The ID of the provider scoring function to use for the scoring function.
+     */
     provider_scoring_fn_id?: string | null;
 }
 export declare namespace ScoringFunctionRegisterParams {

package/dist/resources/scoring-functions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scoring-functions.d.ts","sourceRoot":"","sources":["../src/resources/scoring-functions.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IAIxF;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQjF;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;OAIG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAMtF;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,2BAA2B,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,SAAS,CAAC,UAAU,CAAC;IAElC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,MAAM,CAAC,EACH,SAAS,CAAC,yBAAyB,GACnC,SAAS,CAAC,0BAA0B,GACpC,SAAS,CAAC,oBAAoB,GAC9B,IAAI,CAAC;IAET;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED,yBAAiB,SAAS,CAAC;IACzB,UAAiB,UAAU;QACzB,IAAI,EACA,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,OAAO,GACP,QAAQ,GACR,MAAM,GACN,OAAO,GACP,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,eAAe,CAAC,yBAAyB,GACzC,eAAe,CAAC,0BAA0B,GAC1C,eAAe,CAAC,oBAAoB,CAAC;AAEzC,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAE3D,MAAM,WAAW,6BAA6B;IAC5C,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,6BAA6B,CAAC,UAAU,CAAC;IAEtD,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EACH,6BAA6B,CAAC,yBAAyB,GACvD,6BAA6B,CAAC,0BAA0B,GACxD,6BAA6B,CAAC,oBAAoB,GAClD,IAAI,CAAC;IAET,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,UAAU;QACzB,IAAI,EACA,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,OAAO,GACP,QAAQ,GACR,MAAM,GACN,OAAO,GACP,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
+{"version":3,"file":"scoring-functions.d.ts","sourceRoot":"","sources":["../src/resources/scoring-functions.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IAIxF;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQjF;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;OAIG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAMtF;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,SAAS,CAAC,UAAU,CAAC;IAElC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,MAAM,CAAC,EACH,SAAS,CAAC,yBAAyB,GACnC,SAAS,CAAC,0BAA0B,GACpC,SAAS,CAAC,oBAAoB,GAC9B,IAAI,CAAC;IAET;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED,yBAAiB,SAAS,CAAC;IACzB,UAAiB,UAAU;QACzB,IAAI,EACA,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,OAAO,GACP,QAAQ,GACR,MAAM,GACN,OAAO,GACP,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,eAAe,CAAC,yBAAyB,GACzC,eAAe,CAAC,0BAA0B,GAC1C,eAAe,CAAC,oBAAoB,CAAC;AAEzC,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAE3D,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,6BAA6B,CAAC,UAAU,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EACH,6BAA6B,CAAC,yBAAyB,GACvD,6BAA6B,CAAC,0BAA0B,GACxD,6BAA6B,CAAC,oBAAoB,GAClD,IAAI,CAAC;IAET;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,UAAU;QACzB,IAAI,EACA,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,OAAO,GACP,QAAQ,GACR,MAAM,GACN,OAAO,GACP,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/dist/resources/scoring.d.ts

@@ -15,6 +15,9 @@ export declare class Scoring extends APIResource {
  * The response from scoring.
  */
 export interface ScoringScoreResponse {
+    /**
+     * A map of scoring function name to ScoringResult.
+     */
     results: {
         [key: string]: Shared.ScoringResult;
     };
@@ -23,15 +26,27 @@ export interface ScoringScoreResponse {
  * Response from batch scoring operations on datasets.
  */
 export interface ScoringScoreBatchResponse {
+    /**
+     * A map of scoring function name to ScoringResult
+     */
     results: {
         [key: string]: Shared.ScoringResult;
     };
+    /**
+     * (Optional) The identifier of the dataset that was scored
+     */
     dataset_id?: string | null;
 }
 export interface ScoringScoreParams {
+    /**
+     * The rows to score.
+     */
     input_rows: Array<{
         [key: string]: unknown;
     }>;
+    /**
+     * The scoring functions to use for the scoring.
+     */
     scoring_functions: {
         [key: string]: ScoringScoreParams.LlmAsJudgeScoringFnParams | ScoringScoreParams.RegexParserScoringFnParams | ScoringScoreParams.BasicScoringFnParams | null;
     };
@@ -79,10 +94,19 @@ export declare namespace ScoringScoreParams {
     }
 }
 export interface ScoringScoreBatchParams {
+    /**
+     * The ID of the dataset to score.
+     */
     dataset_id: string;
+    /**
+     * The scoring functions to use for the scoring.
+     */
     scoring_functions: {
         [key: string]: ScoringScoreBatchParams.LlmAsJudgeScoringFnParams | ScoringScoreBatchParams.RegexParserScoringFnParams | ScoringScoreBatchParams.BasicScoringFnParams | null;
     };
+    /**
+     * Whether to save the results to a dataset.
+     */
     save_results_dataset?: boolean;
 }
 export declare namespace ScoringScoreBatchParams {

package/dist/resources/scoring.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scoring.d.ts","sourceRoot":"","sources":["../src/resources/scoring.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIrG;;OAEG;IACH,UAAU,CACR,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAA;KAAE,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAA;KAAE,CAAC;IAEjD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE9C,iBAAiB,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GACR,kBAAkB,CAAC,yBAAyB,GAC5C,kBAAkB,CAAC,0BAA0B,GAC7C,kBAAkB,CAAC,oBAAoB,GACvC,IAAI,CAAC;KACV,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;IAEnB,iBAAiB,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GACR,uBAAuB,CAAC,yBAAyB,GACjD,uBAAuB,CAAC,0BAA0B,GAClD,uBAAuB,CAAC,oBAAoB,GAC5C,IAAI,CAAC;KACV,CAAC;IAEF,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"scoring.d.ts","sourceRoot":"","sources":["../src/resources/scoring.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIrG;;OAEG;IACH,UAAU,CACR,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAA;KAAE,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAA;KAAE,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE9C;;OAEG;IACH,iBAAiB,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GACR,kBAAkB,CAAC,yBAAyB,GAC5C,kBAAkB,CAAC,0BAA0B,GAC7C,kBAAkB,CAAC,oBAAoB,GACvC,IAAI,CAAC;KACV,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GACR,uBAAuB,CAAC,yBAAyB,GACjD,uBAAuB,CAAC,0BAA0B,GAClD,uBAAuB,CAAC,oBAAoB,GAC5C,IAAI,CAAC;KACV,CAAC;IAEF;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,yBAAyB;QACxC,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAC3B,SAAS,GAAG,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,GAAG,UAAU,CAC7E,CAAC;QAEF,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/dist/resources/shared.d.ts

@@ -1,3 +1,14 @@
+import * as ProvidersAPI from "./providers.js";
+import * as RoutesAPI from "./routes.js";
+/**
+ * Health status information for the service.
+ */
+export interface HealthInfo {
+    /**
+     * The health status of the service
+     */
+    status: 'OK' | 'Error' | 'Not Implemented';
+}
 /**
  * A image content item
  */
@@ -121,6 +132,24 @@ export declare namespace InterleavedContentItem {
         type?: 'text';
     }
 }
+/**
+ * Response containing a list of all available providers.
+ */
+export interface ListProvidersResponse {
+    /**
+     * List of provider information objects
+     */
+    data: ProvidersAPI.ProviderListResponse;
+}
+/**
+ * Response containing a list of all available API routes.
+ */
+export interface ListRoutesResponse {
+    /**
+     * List of available API routes
+     */
+    data: RoutesAPI.RouteListResponse;
+}
 /**
  * Parameter type for string values.
  */
@@ -181,29 +210,94 @@ export declare namespace ParamType {
         type?: 'completion_input';
     }
 }
+/**
+ * Information about a registered provider including its configuration and health
+ * status.
+ */
+export interface ProviderInfo {
+    /**
+     * The API name this provider implements
+     */
+    api: string;
+    /**
+     * Configuration parameters for the provider
+     */
+    config: {
+        [key: string]: unknown;
+    };
+    /**
+     * Current health status of the provider
+     */
+    health: {
+        [key: string]: unknown;
+    };
+    /**
+     * Unique identifier for the provider
+     */
+    provider_id: string;
+    /**
+     * The type of provider implementation
+     */
+    provider_type: string;
+}
+/**
+ * Information about an API route including its path, method, and implementing
+ * providers.
+ */
+export interface RouteInfo {
+    /**
+     * The HTTP method for the route
+     */
+    method: string;
+    /**
+     * List of provider types implementing this route
+     */
+    provider_types: Array<string>;
+    /**
+     * The API route path
+     */
+    route: string;
+}
 /**
  * Details of a safety violation detected by content moderation.
  */
 export interface SafetyViolation {
     /**
-     * Severity level of a safety violation.
+     * Severity level of the violation
      */
     violation_level: 'info' | 'warn' | 'error';
+    /**
+     * Additional metadata including specific violation codes
+     */
     metadata?: {
         [key: string]: unknown;
     };
+    /**
+     * Message to convey to the user about the violation
+     */
     user_message?: string | null;
 }
 /**
- * Sampling parameters.
+ * Sampling parameters for text generation.
  */
 export interface SamplingParams {
+    /**
+     * The maximum number of tokens that can be generated in the completion. The token
+     * count of your prompt plus max_tokens cannot exceed the model's context length.
+     */
     max_tokens?: number | null;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+     * whether they appear in the text so far.
+     */
     repetition_penalty?: number | null;
+    /**
+     * Up to 4 sequences where the API will stop generating further tokens. The
+     * returned text will not contain the stop sequence.
+     */
     stop?: Array<string> | null;
     /**
-     * Greedy sampling strategy that selects the highest probability token at each
-     * step.
+     * The sampling strategy to use.
      */
     strategy?: SamplingParams.GreedySamplingStrategy | SamplingParams.TopPSamplingStrategy | SamplingParams.TopKSamplingStrategy;
 }
@@ -213,6 +307,9 @@ export declare namespace SamplingParams {
      * step.
      */
     interface GreedySamplingStrategy {
+        /**
+         * Must be 'greedy' to identify this sampling strategy.
+         */
         type?: 'greedy';
     }
     /**
@@ -220,15 +317,30 @@ export declare namespace SamplingParams {
      * with cumulative probability >= p.
      */
     interface TopPSamplingStrategy {
-        temperature: number | null;
-        top_p?: number | null;
+        /**
+         * Controls randomness in sampling. Higher values increase randomness.
+         */
+        temperature: number;
+        /**
+         * Cumulative probability threshold for nucleus sampling.
+         */
+        top_p?: number;
+        /**
+         * Must be 'top_p' to identify this sampling strategy.
+         */
         type?: 'top_p';
     }
     /**
      * Top-k sampling strategy that restricts sampling to the k most likely tokens.
      */
     interface TopKSamplingStrategy {
+        /**
+         * Number of top tokens to consider for sampling. Must be at least 1.
+         */
         top_k: number;
+        /**
+         * Must be 'top_k' to identify this sampling strategy.
+         */
         type?: 'top_k';
     }
 }
@@ -236,9 +348,15 @@ export declare namespace SamplingParams {
  * A scoring result for a single row.
  */
 export interface ScoringResult {
+    /**
+     * Map of metric name to aggregated value
+     */
     aggregated_results: {
         [key: string]: unknown;
     };
+    /**
+     * The scoring result for each row. Each row is a map of column name to value.
+     */
     score_rows: Array<{
         [key: string]: unknown;
     }>;
@@ -248,9 +366,14 @@ export interface ScoringResult {
  */
 export interface SystemMessage {
     /**
-     * A image content item
+     * The content of the 'system prompt'. If multiple system messages are provided,
+     * they are concatenated. The underlying Llama Stack code may also add other system
+     * messages.
      */
     content: string | SystemMessage.ImageContentItemInput | SystemMessage.TextContentItem | Array<SystemMessage.ImageContentItemInput | SystemMessage.TextContentItem>;
+    /**
+     * Must be 'system' to identify this as a system message.
+     */
     role?: 'system';
 }
 export declare namespace SystemMessage {
@@ -329,4 +452,13 @@ export declare namespace SystemMessage {
         type?: 'text';
     }
 }
+/**
+ * Version information for the service.
+ */
+export interface VersionInfo {
+    /**
+     * The version string of the service
+     */
+    version: string;
+}
 //# sourceMappingURL=shared.d.ts.map

package/dist/resources/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN,kBAAkB,CAAC,gBAAgB,GACnC,kBAAkB,CAAC,eAAe,GAClC,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;AAEpF,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,gBAAgB,GACvC,sBAAsB,CAAC,eAAe,CAAC;AAE3C,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,QAAQ,GAClB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,uBAAuB,GACjC,SAAS,CAAC,mBAAmB,CAAC;AAElC,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC,IAAI,CAAC,EAAE,uBAAuB,CAAC;KAChC;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,IAAI,CAAC,EAAE,kBAAkB,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EACL,cAAc,CAAC,sBAAsB,GACrC,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,oBAAoB,CAAC;CACzC;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;OAGG;IACH,UAAiB,sBAAsB;QACrC,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;;OAGG;IACH,UAAiB,oBAAoB;QACnC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,kBAAkB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE/C,UAAU,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EACH,MAAM,GACN,aAAa,CAAC,qBAAqB,GACnC,aAAa,CAAC,eAAe,GAC7B,KAAK,CAAC,aAAa,CAAC,qBAAqB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;IAE/E,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC,KAAK,CAAC;QAEnC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,qBAAqB,CAAC;QACrC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC,KAAK,CAAC;QAEnC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,qBAAqB,CAAC;QACrC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,MAAM,EAAE,IAAI,GAAG,OAAO,GAAG,iBAAiB,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN,kBAAkB,CAAC,gBAAgB,GACnC,kBAAkB,CAAC,eAAe,GAClC,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;AAEpF,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,gBAAgB,GACvC,sBAAsB,CAAC,eAAe,CAAC;AAE3C,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC,oBAAoB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,QAAQ,GAClB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,uBAAuB,GACjC,SAAS,CAAC,mBAAmB,CAAC;AAElC,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC,IAAI,CAAC,EAAE,uBAAuB,CAAC;KAChC;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,IAAI,CAAC,EAAE,kBAAkB,CAAC;KAC3B;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EACL,cAAc,CAAC,sBAAsB,GACrC,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,oBAAoB,CAAC;CACzC;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;OAGG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;;OAGG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,kBAAkB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EACH,MAAM,GACN,aAAa,CAAC,qBAAqB,GACnC,aAAa,CAAC,eAAe,GAC7B,KAAK,CAAC,aAAa,CAAC,qBAAqB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;IAE/E;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC,KAAK,CAAC;QAEnC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,qBAAqB,CAAC;QACrC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC,KAAK,CAAC;QAEnC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,qBAAqB,CAAC;QACrC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/resources/shields.d.ts

@@ -22,7 +22,13 @@ export declare class Shields extends APIResource {
      */
     register(body: ShieldRegisterParams, options?: Core.RequestOptions): Core.APIPromise<Shield>;
 }
+/**
+ * Response containing a list of all shields.
+ */
 export interface ListShieldsResponse {
+    /**
+     * List of shield objects
+     */
     data: ShieldListResponse;
 }
 /**
@@ -46,13 +52,28 @@ export interface Shield {
     provider_resource_id?: string | null;
     type?: 'shield';
 }
+/**
+ * List of shield objects
+ */
 export type ShieldListResponse = Array<Shield>;
 export interface ShieldRegisterParams {
+    /**
+     * The identifier of the shield to register.
+     */
     shield_id: string;
+    /**
+     * The parameters of the shield.
+     */
     params?: {
         [key: string]: unknown;
     } | null;
+    /**
+     * The identifier of the provider.
+     */
     provider_id?: string | null;
+    /**
+     * The identifier of the shield in the provider.
+     */
     provider_shield_id?: string | null;
 }
 export declare namespace Shields {

package/dist/resources/shields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shields.d.ts","sourceRoot":"","sources":["../src/resources/shields.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIpF;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAMxE;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAG7F;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAE/C,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"shields.d.ts","sourceRoot":"","sources":["../src/resources/shields.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIpF;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAMxE;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAE/C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}