@databricks/sdk-modelservingquery 0.0.0-dev → 0.1.0-dev.2

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Databricks, Inc.  All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/v1/client.d.ts

@@ -0,0 +1,14 @@
+import type { CallOptions } from '@databricks/sdk-options/call';
+import type { ClientOptions } from '@databricks/sdk-options/client';
+import type { QueryEndpointInputRequest, QueryEndpointResponse } from './model';
+export declare class ModelServingQueryClient {
+    private readonly host;
+    private readonly workspaceId;
+    private readonly httpClient;
+    private readonly logger;
+    private readonly userAgent;
+    constructor(options: ClientOptions);
+    /** Query a serving endpoint */
+    query(req: QueryEndpointInputRequest, options?: CallOptions): Promise<QueryEndpointResponse>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/v1/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAWlE,OAAO,KAAK,EAAC,yBAAyB,EAAE,qBAAqB,EAAC,MAAM,SAAS,CAAC;AAY9E,qBAAa,uBAAuB;IAClC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAI9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,OAAO,EAAE,aAAa;IAelC,+BAA+B;IACzB,KAAK,CACT,GAAG,EAAE,yBAAyB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC;CAwBlC"}

package/dist/v1/client.js

@@ -0,0 +1,66 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+import { VERSION as AUTH_VERSION } from '@databricks/sdk-auth';
+import { createDefault } from '@databricks/sdk-core/clientinfo';
+import { NoOpLogger } from '@databricks/sdk-core/logger';
+import { newHttpClient } from './transport';
+import { buildHttpRequest, executeCall, executeHttpCall, marshalRequest, parseResponse, } from './utils';
+import pkgJson from '../../package.json' with { type: 'json' };
+import { marshalQueryEndpointInputRequestSchema, unmarshalQueryEndpointResponseSchema, } from './model';
+// Package identity segment for this client to be used in the User-Agent header.
+const PACKAGE_SEGMENT = {
+    key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
+    value: pkgJson.version,
+};
+export class ModelServingQueryClient {
+    host;
+    // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
+    // When set, workspace-level methods send X-Databricks-Org-Id on every
+    // request.
+    workspaceId;
+    httpClient;
+    logger;
+    // User-Agent header value. Composed once at construction from
+    // createDefault() merged with this package's identity and the active
+    // credential's name.
+    userAgent;
+    constructor(options) {
+        if (options.host === undefined) {
+            throw new Error('Host is required.');
+        }
+        this.host = options.host.replace(/\/$/, '');
+        this.workspaceId = options.workspaceId;
+        this.logger = options.logger ?? new NoOpLogger();
+        const info = createDefault()
+            .with(PACKAGE_SEGMENT)
+            .with({ key: 'sdk-js-auth', value: AUTH_VERSION })
+            .with({ key: 'auth', value: options.credentials?.name() ?? 'default' });
+        this.userAgent = info.toString();
+        this.httpClient = newHttpClient(options);
+    }
+    /** Query a serving endpoint */
+    async query(req, options) {
+        const url = `${this.host}/api/serving-endpoints/${req.name ?? ''}/invocations`;
+        const body = marshalRequest(req, marshalQueryEndpointInputRequestSchema);
+        let resp;
+        const call = async (callSignal) => {
+            const headers = new Headers({ 'Content-Type': 'application/json' });
+            if (this.workspaceId !== undefined) {
+                headers.set('X-Databricks-Org-Id', this.workspaceId);
+            }
+            headers.set('User-Agent', this.userAgent);
+            const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
+            const respBody = await executeHttpCall({
+                request: httpReq,
+                httpClient: this.httpClient,
+                logger: this.logger,
+            });
+            resp = parseResponse(respBody, unmarshalQueryEndpointResponseSchema);
+        };
+        await executeCall(call, options);
+        if (resp === undefined) {
+            throw new Error('operation completed without a result.');
+        }
+        return resp;
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/v1/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAE/E,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAE9D,OAAO,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAC;AAIvD,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAC1C,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,cAAc,EACd,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,OAAO,MAAM,oBAAoB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAE7D,OAAO,EACL,sCAAsC,EACtC,oCAAoC,GACrC,MAAM,SAAS,CAAC;AAEjB,gFAAgF;AAChF,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;IAC1D,KAAK,EAAE,OAAO,CAAC,OAAO;CACvB,CAAC;AAEF,MAAM,OAAO,uBAAuB;IACjB,IAAI,CAAS;IAC9B,4EAA4E;IAC5E,sEAAsE;IACtE,WAAW;IACM,WAAW,CAAqB;IAChC,UAAU,CAAa;IACvB,MAAM,CAAS;IAChC,8DAA8D;IAC9D,qEAAqE;IACrE,qBAAqB;IACJ,SAAS,CAAS;IAEnC,YAAY,OAAsB;QAChC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QACjD,MAAM,IAAI,GAAG,aAAa,EAAE;aACzB,IAAI,CAAC,eAAe,CAAC;aACrB,IAAI,CAAC,EAAC,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,YAAY,EAAC,CAAC;aAC/C,IAAI,CAAC,EAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,SAAS,EAAC,CAAC,CAAC;QACxE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,KAAK,CACT,GAA8B,EAC9B,OAAqB;QAErB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,0BAA0B,GAAG,CAAC,IAAI,IAAI,EAAE,cAAc,CAAC;QAC/E,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC;QACzE,IAAI,IAAuC,CAAC;QAC5C,MAAM,IAAI,GAAG,KAAK,EAAE,UAAwB,EAAiB,EAAE;YAC7D,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAC,cAAc,EAAE,kBAAkB,EAAC,CAAC,CAAC;YAClE,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;gBACrC,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;YACH,IAAI,GAAG,aAAa,CAAC,QAAQ,EAAE,oCAAoC,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/v1/index.d.ts

@@ -0,0 +1,4 @@
+export { ModelServingQueryClient } from './client';
+export { ChatMessageRole, EmbeddingsV1ResponseEmbeddingElementObject, QueryEndpointResponseObject, } from './model';
+export type { ChatMessage, DataframeSplitInput, EmbeddingsV1ResponseEmbeddingElement, ExternalModelUsageElement, QueryEndpointInputRequest, QueryEndpointInputRequest_ExtraParamsEntry, QueryEndpointInputRequest_UsageContextEntry, QueryEndpointResponse, V1ResponseChoiceElement, } from './model';
+//# sourceMappingURL=index.d.ts.map

package/dist/v1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,uBAAuB,EAAC,MAAM,UAAU,CAAC;AAEjD,OAAO,EACL,eAAe,EACf,0CAA0C,EAC1C,2BAA2B,GAC5B,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,WAAW,EACX,mBAAmB,EACnB,oCAAoC,EACpC,yBAAyB,EACzB,yBAAyB,EACzB,0CAA0C,EAC1C,2CAA2C,EAC3C,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,SAAS,CAAC"}

package/dist/v1/index.js

@@ -0,0 +1,4 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+export { ModelServingQueryClient } from './client';
+export { ChatMessageRole, EmbeddingsV1ResponseEmbeddingElementObject, QueryEndpointResponseObject, } from './model';
+//# sourceMappingURL=index.js.map

package/dist/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAE/E,OAAO,EAAC,uBAAuB,EAAC,MAAM,UAAU,CAAC;AAEjD,OAAO,EACL,eAAe,EACf,0CAA0C,EAC1C,2BAA2B,GAC5B,MAAM,SAAS,CAAC"}

package/dist/v1/model.d.ts

@@ -0,0 +1,178 @@
+import type { JsonValue } from '@databricks/sdk-core/wkt';
+import { z } from 'zod';
+/** The role of the message. One of [system, user, assistant]. */
+export declare enum ChatMessageRole {
+    CHAT_MESSAGE_ROLE_UNSPECIFIED = "CHAT_MESSAGE_ROLE_UNSPECIFIED",
+    SYSTEM = "system",
+    USER = "user",
+    ASSISTANT = "assistant"
+}
+/** This will always be 'embedding'. */
+export declare enum EmbeddingsV1ResponseEmbeddingElementObject {
+    EMBEDDINGS_V1_RESPONSE_EMBEDDING_ELEMENT_OBJECT_UNSPECIFIED = "EMBEDDINGS_V1_RESPONSE_EMBEDDING_ELEMENT_OBJECT_UNSPECIFIED",
+    EMBEDDING = "embedding"
+}
+/**
+ * The type of object returned by the __external/foundation model__ serving endpoint, one of
+ * [text_completion, chat.completion, list (of embeddings)].
+ */
+export declare enum QueryEndpointResponseObject {
+    QUERY_ENDPOINT_RESPONSE_OBJECT_UNSPECIFIED = "QUERY_ENDPOINT_RESPONSE_OBJECT_UNSPECIFIED",
+    TEXT_COMPLETION = "text_completion",
+    CHAT_COMPLETION = "chat.completion",
+    LIST = "list"
+}
+export interface ChatMessage {
+    /** The role of the message. One of [system, user, assistant]. */
+    role?: ChatMessageRole | undefined;
+    /** The content of the message. */
+    content?: string | undefined;
+}
+export interface DataframeSplitInput {
+    /** Index array for the dataframe */
+    index?: number[] | undefined;
+    /** Columns array for the dataframe */
+    columns?: JsonValue[] | undefined;
+    /** Data array for the dataframe */
+    data?: JsonValue[] | undefined;
+}
+export interface EmbeddingsV1ResponseEmbeddingElement {
+    /** The embedding vector */
+    embedding?: number[] | undefined;
+    /** The index of the embedding in the response. */
+    index?: number | undefined;
+    /** This will always be 'embedding'. */
+    object?: EmbeddingsV1ResponseEmbeddingElementObject | undefined;
+}
+export interface ExternalModelUsageElement {
+    /** The number of tokens in the prompt. */
+    promptTokens?: number | undefined;
+    /** The number of tokens in the chat/completions response. */
+    completionTokens?: number | undefined;
+    /** The total number of tokens in the prompt and response. */
+    totalTokens?: number | undefined;
+}
+export interface QueryEndpointInputRequest {
+    /** The name of the serving endpoint. This field is required and is provided via the path parameter. */
+    name?: string | undefined;
+    /**
+     * The prompt string (or array of strings) field used ONLY for __completions external & foundation model__
+     * serving endpoints and should only be used with other completions query fields.
+     */
+    prompt?: JsonValue | undefined;
+    /**
+     * The input string (or array of strings) field used ONLY for __embeddings external & foundation model__
+     * serving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.
+     */
+    input?: JsonValue | undefined;
+    /**
+     * The messages field used ONLY for __chat external & foundation model__ serving endpoints.
+     * This is an array of ChatMessage objects and should only be used with other chat query fields.
+     */
+    messages?: ChatMessage[] | undefined;
+    /**
+     * The temperature field used ONLY for __completions__ and __chat external & foundation model__ serving
+     * endpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with other
+     * chat/completions query fields.
+     */
+    temperature?: number | undefined;
+    /**
+     * The stop sequences field used ONLY for __completions__ and __chat external & foundation model__ serving
+     * endpoints. This is a list of strings and should only be used with other chat/completions query fields.
+     */
+    stop?: string[] | undefined;
+    /**
+     * The max tokens field used ONLY for __completions__ and __chat external & foundation model__ serving
+     * endpoints. This is an integer and should only be used with other chat/completions query fields.
+     */
+    maxTokens?: number | undefined;
+    /**
+     * The n (number of candidates) field used ONLY for __completions__ and __chat external & foundation model__
+     * serving endpoints. This is an integer between 1 and 5 with a default of 1 and should only be used with
+     * other chat/completions query fields.
+     */
+    n?: number | undefined;
+    /**
+     * The stream field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints.
+     * This is a boolean defaulting to false and should only be used with other chat/completions query fields.
+     */
+    stream?: boolean | undefined;
+    /**
+     * The extra parameters field used ONLY for __completions, chat,__ and __embeddings external & foundation
+     * model__ serving endpoints. This is a map of strings and should only be used with other external/foundation
+     * model query fields.
+     */
+    extraParams?: Record<string, string> | undefined;
+    /** Pandas Dataframe input in the records orientation. */
+    dataframeRecords?: JsonValue[] | undefined;
+    /** Pandas Dataframe input in the split orientation. */
+    dataframeSplit?: DataframeSplitInput | undefined;
+    /** Tensor-based input in row format. */
+    instances?: JsonValue[] | undefined;
+    /** Tensor-based input in columnar format. */
+    inputs?: JsonValue | undefined;
+    /** Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table. */
+    clientRequestId?: string | undefined;
+    /** Optional user-provided context that will be recorded in the usage tracking table. */
+    usageContext?: Record<string, string> | undefined;
+}
+export interface QueryEndpointInputRequest_ExtraParamsEntry {
+    key?: string | undefined;
+    value?: string | undefined;
+}
+export interface QueryEndpointInputRequest_UsageContextEntry {
+    key?: string | undefined;
+    value?: string | undefined;
+}
+export interface QueryEndpointResponse {
+    /** The list of choices returned by the __chat or completions external/foundation model__ serving endpoint. */
+    choices?: V1ResponseChoiceElement[] | undefined;
+    /** The list of the embeddings returned by the __embeddings external/foundation model__ serving endpoint. */
+    data?: EmbeddingsV1ResponseEmbeddingElement[] | undefined;
+    /**
+     * The name of the __external/foundation model__ used for querying. This is the name of the model that was
+     * specified in the endpoint config.
+     */
+    model?: string | undefined;
+    /**
+     * The usage object that may be returned by the __external/foundation model__ serving endpoint. This
+     * contains information about the number of tokens used in the prompt and response.
+     */
+    usage?: ExternalModelUsageElement | undefined;
+    /** The ID of the query that may be returned by a __completions or chat external/foundation model__ serving endpoint. */
+    id?: string | undefined;
+    /** The timestamp in seconds when the query was created in Unix time returned by a __completions or chat external/foundation model__ serving endpoint. */
+    created?: bigint | undefined;
+    /**
+     * The type of object returned by the __external/foundation model__ serving endpoint, one of
+     * [text_completion, chat.completion, list (of embeddings)].
+     */
+    object?: QueryEndpointResponseObject | undefined;
+    /** The predictions returned by the serving endpoint. */
+    predictions?: JsonValue[] | undefined;
+    /** The outputs of the feature serving endpoint. */
+    outputs?: JsonValue[] | undefined;
+    /** The name of the served model that served the request. This is useful when there are multiple models behind the same endpoint with traffic split. */
+    servedModelName?: string | undefined;
+}
+export interface V1ResponseChoiceElement {
+    /** The text response from the __completions__ endpoint. */
+    text?: string | undefined;
+    /** The message response from the __chat__ endpoint. */
+    message?: ChatMessage | undefined;
+    /** The index of the choice in the __chat or completions__ response. */
+    index?: number | undefined;
+    /** The finish reason returned by the endpoint. */
+    finishReason?: string | undefined;
+    /** The logprobs returned only by the __completions__ endpoint. */
+    logprobs?: number | undefined;
+}
+export declare const unmarshalChatMessageSchema: z.ZodType<ChatMessage>;
+export declare const unmarshalEmbeddingsV1ResponseEmbeddingElementSchema: z.ZodType<EmbeddingsV1ResponseEmbeddingElement>;
+export declare const unmarshalExternalModelUsageElementSchema: z.ZodType<ExternalModelUsageElement>;
+export declare const unmarshalQueryEndpointResponseSchema: z.ZodType<QueryEndpointResponse>;
+export declare const unmarshalV1ResponseChoiceElementSchema: z.ZodType<V1ResponseChoiceElement>;
+export declare const marshalChatMessageSchema: z.ZodType;
+export declare const marshalDataframeSplitInputSchema: z.ZodType;
+export declare const marshalQueryEndpointInputRequestSchema: z.ZodType;
+//# sourceMappingURL=model.d.ts.map

package/dist/v1/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/v1/model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAatB,iEAAiE;AACjE,oBAAY,eAAe;IACzB,6BAA6B,kCAAkC;IAC/D,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,SAAS,cAAc;CACxB;AAED,uCAAuC;AACvC,oBAAY,0CAA0C;IACpD,2DAA2D,gEAAgE;IAC3H,SAAS,cAAc;CACxB;AAED;;;GAGG;AACH,oBAAY,2BAA2B;IACrC,0CAA0C,+CAA+C;IACzF,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,IAAI,SAAS;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,IAAI,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACnC,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B,sCAAsC;IACtC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAClC,mCAAmC;IACnC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,oCAAoC;IACnD,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACjC,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,uCAAuC;IACvC,MAAM,CAAC,EAAE,0CAA0C,GAAG,SAAS,CAAC;CACjE;AAED,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,yBAAyB;IACxC,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;;OAGG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;IACrC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IACjD,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAC3C,uDAAuD;IACvD,cAAc,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IACjD,wCAAwC;IACxC,SAAS,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACpC,6CAA6C;IAC7C,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC/B,2HAA2H;IAC3H,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CACnD;AAGD,MAAM,WAAW,0CAA0C;IACzD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAGD,MAAM,WAAW,2CAA2C;IAC1D,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,8GAA8G;IAC9G,OAAO,CAAC,EAAE,uBAAuB,EAAE,GAAG,SAAS,CAAC;IAChD,4GAA4G;IAC5G,IAAI,CAAC,EAAE,oCAAoC,EAAE,GAAG,SAAS,CAAC;IAC1D;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;OAGG;IACH,KAAK,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAC9C,wHAAwH;IACxH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,yJAAyJ;IACzJ,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IACjD,wDAAwD;IACxD,WAAW,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACtC,mDAAmD;IACnD,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAClC,uJAAuJ;IACvJ,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,uBAAuB;IACtC,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,uDAAuD;IACvD,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAClC,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAQzD,CAAC;AAEN,eAAO,MAAM,mDAAmD,EAAE,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAWzG,CAAC;AAER,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAWnF,CAAC;AAER,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAkC3E,CAAC;AAER,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAe/E,CAAC;AAER,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAQpC,CAAC;AAEN,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAU5C,CAAC;AAEN,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAoClD,CAAC"}