@azure-rest/ai-inference 1.0.0-beta.1 → 1.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +123 -4
- package/dist/browser/clientDefinitions.d.ts +20 -2
- package/dist/browser/clientDefinitions.d.ts.map +1 -1
- package/dist/browser/clientDefinitions.js +1 -1
- package/dist/browser/clientDefinitions.js.map +1 -1
- package/dist/browser/constants.d.ts +2 -0
- package/dist/browser/constants.d.ts.map +1 -0
- package/dist/browser/constants.js +4 -0
- package/dist/browser/constants.js.map +1 -0
- package/dist/browser/index.js +1 -1
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/isUnexpected.d.ts +3 -1
- package/dist/browser/isUnexpected.d.ts.map +1 -1
- package/dist/browser/isUnexpected.js +4 -3
- package/dist/browser/isUnexpected.js.map +1 -1
- package/dist/browser/logger.js +1 -1
- package/dist/browser/logger.js.map +1 -1
- package/dist/browser/modelClient.d.ts +6 -1
- package/dist/browser/modelClient.d.ts.map +1 -1
- package/dist/browser/modelClient.js +28 -7
- package/dist/browser/modelClient.js.map +1 -1
- package/dist/browser/models.d.ts +54 -39
- package/dist/browser/models.d.ts.map +1 -1
- package/dist/browser/models.js +1 -1
- package/dist/browser/models.js.map +1 -1
- package/dist/browser/outputModels.d.ts +48 -22
- package/dist/browser/outputModels.d.ts.map +1 -1
- package/dist/browser/outputModels.js +1 -1
- package/dist/browser/outputModels.js.map +1 -1
- package/dist/browser/parameters.d.ts +53 -4
- package/dist/browser/parameters.d.ts.map +1 -1
- package/dist/browser/parameters.js +1 -1
- package/dist/browser/parameters.js.map +1 -1
- package/dist/browser/responses.d.ts +29 -1
- package/dist/browser/responses.d.ts.map +1 -1
- package/dist/browser/responses.js +1 -1
- package/dist/browser/responses.js.map +1 -1
- package/dist/browser/tracingHelper.d.ts +9 -0
- package/dist/browser/tracingHelper.d.ts.map +1 -0
- package/dist/browser/tracingHelper.js +198 -0
- package/dist/browser/tracingHelper.js.map +1 -0
- package/dist/browser/tracingPolicy.d.ts +12 -0
- package/dist/browser/tracingPolicy.d.ts.map +1 -0
- package/dist/browser/tracingPolicy.js +68 -0
- package/dist/browser/tracingPolicy.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +20 -2
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -1
- package/dist/commonjs/clientDefinitions.js +1 -1
- package/dist/commonjs/clientDefinitions.js.map +1 -1
- package/dist/commonjs/constants.d.ts +2 -0
- package/dist/commonjs/constants.d.ts.map +1 -0
- package/dist/commonjs/constants.js +7 -0
- package/dist/commonjs/constants.js.map +1 -0
- package/dist/commonjs/index.js +1 -1
- package/dist/commonjs/index.js.map +1 -1
- package/dist/commonjs/isUnexpected.d.ts +3 -1
- package/dist/commonjs/isUnexpected.d.ts.map +1 -1
- package/dist/commonjs/isUnexpected.js +5 -5
- package/dist/commonjs/isUnexpected.js.map +1 -1
- package/dist/commonjs/logger.js +1 -1
- package/dist/commonjs/logger.js.map +1 -1
- package/dist/commonjs/modelClient.d.ts +6 -1
- package/dist/commonjs/modelClient.d.ts.map +1 -1
- package/dist/commonjs/modelClient.js +28 -7
- package/dist/commonjs/modelClient.js.map +1 -1
- package/dist/commonjs/models.d.ts +54 -39
- package/dist/commonjs/models.d.ts.map +1 -1
- package/dist/commonjs/models.js +1 -1
- package/dist/commonjs/models.js.map +1 -1
- package/dist/commonjs/outputModels.d.ts +48 -22
- package/dist/commonjs/outputModels.d.ts.map +1 -1
- package/dist/commonjs/outputModels.js +1 -1
- package/dist/commonjs/outputModels.js.map +1 -1
- package/dist/commonjs/parameters.d.ts +53 -4
- package/dist/commonjs/parameters.d.ts.map +1 -1
- package/dist/commonjs/parameters.js +1 -1
- package/dist/commonjs/parameters.js.map +1 -1
- package/dist/commonjs/responses.d.ts +29 -1
- package/dist/commonjs/responses.d.ts.map +1 -1
- package/dist/commonjs/responses.js +1 -1
- package/dist/commonjs/responses.js.map +1 -1
- package/dist/commonjs/tracingHelper.d.ts +9 -0
- package/dist/commonjs/tracingHelper.d.ts.map +1 -0
- package/dist/commonjs/tracingHelper.js +205 -0
- package/dist/commonjs/tracingHelper.js.map +1 -0
- package/dist/commonjs/tracingPolicy.d.ts +12 -0
- package/dist/commonjs/tracingPolicy.d.ts.map +1 -0
- package/dist/commonjs/tracingPolicy.js +72 -0
- package/dist/commonjs/tracingPolicy.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +1 -1
- package/dist/esm/clientDefinitions.d.ts +20 -2
- package/dist/esm/clientDefinitions.d.ts.map +1 -1
- package/dist/esm/clientDefinitions.js +1 -1
- package/dist/esm/clientDefinitions.js.map +1 -1
- package/dist/esm/constants.d.ts +2 -0
- package/dist/esm/constants.d.ts.map +1 -0
- package/dist/esm/constants.js +4 -0
- package/dist/esm/constants.js.map +1 -0
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/isUnexpected.d.ts +3 -1
- package/dist/esm/isUnexpected.d.ts.map +1 -1
- package/dist/esm/isUnexpected.js +4 -3
- package/dist/esm/isUnexpected.js.map +1 -1
- package/dist/esm/logger.js +1 -1
- package/dist/esm/logger.js.map +1 -1
- package/dist/esm/modelClient.d.ts +6 -1
- package/dist/esm/modelClient.d.ts.map +1 -1
- package/dist/esm/modelClient.js +28 -7
- package/dist/esm/modelClient.js.map +1 -1
- package/dist/esm/models.d.ts +54 -39
- package/dist/esm/models.d.ts.map +1 -1
- package/dist/esm/models.js +1 -1
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/outputModels.d.ts +48 -22
- package/dist/esm/outputModels.d.ts.map +1 -1
- package/dist/esm/outputModels.js +1 -1
- package/dist/esm/outputModels.js.map +1 -1
- package/dist/esm/parameters.d.ts +53 -4
- package/dist/esm/parameters.d.ts.map +1 -1
- package/dist/esm/parameters.js +1 -1
- package/dist/esm/parameters.js.map +1 -1
- package/dist/esm/responses.d.ts +29 -1
- package/dist/esm/responses.d.ts.map +1 -1
- package/dist/esm/responses.js +1 -1
- package/dist/esm/responses.js.map +1 -1
- package/dist/esm/tracingHelper.d.ts +9 -0
- package/dist/esm/tracingHelper.d.ts.map +1 -0
- package/dist/esm/tracingHelper.js +198 -0
- package/dist/esm/tracingHelper.js.map +1 -0
- package/dist/esm/tracingPolicy.d.ts +12 -0
- package/dist/esm/tracingPolicy.d.ts.map +1 -0
- package/dist/esm/tracingPolicy.js +68 -0
- package/dist/esm/tracingPolicy.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +20 -2
- package/dist/react-native/clientDefinitions.d.ts.map +1 -1
- package/dist/react-native/clientDefinitions.js +1 -1
- package/dist/react-native/clientDefinitions.js.map +1 -1
- package/dist/react-native/constants.d.ts +2 -0
- package/dist/react-native/constants.d.ts.map +1 -0
- package/dist/react-native/constants.js +4 -0
- package/dist/react-native/constants.js.map +1 -0
- package/dist/react-native/index.js +1 -1
- package/dist/react-native/index.js.map +1 -1
- package/dist/react-native/isUnexpected.d.ts +3 -1
- package/dist/react-native/isUnexpected.d.ts.map +1 -1
- package/dist/react-native/isUnexpected.js +4 -3
- package/dist/react-native/isUnexpected.js.map +1 -1
- package/dist/react-native/logger.js +1 -1
- package/dist/react-native/logger.js.map +1 -1
- package/dist/react-native/modelClient.d.ts +6 -1
- package/dist/react-native/modelClient.d.ts.map +1 -1
- package/dist/react-native/modelClient.js +28 -7
- package/dist/react-native/modelClient.js.map +1 -1
- package/dist/react-native/models.d.ts +54 -39
- package/dist/react-native/models.d.ts.map +1 -1
- package/dist/react-native/models.js +1 -1
- package/dist/react-native/models.js.map +1 -1
- package/dist/react-native/outputModels.d.ts +48 -22
- package/dist/react-native/outputModels.d.ts.map +1 -1
- package/dist/react-native/outputModels.js +1 -1
- package/dist/react-native/outputModels.js.map +1 -1
- package/dist/react-native/parameters.d.ts +53 -4
- package/dist/react-native/parameters.d.ts.map +1 -1
- package/dist/react-native/parameters.js +1 -1
- package/dist/react-native/parameters.js.map +1 -1
- package/dist/react-native/responses.d.ts +29 -1
- package/dist/react-native/responses.d.ts.map +1 -1
- package/dist/react-native/responses.js +1 -1
- package/dist/react-native/responses.js.map +1 -1
- package/dist/react-native/tracingHelper.d.ts +9 -0
- package/dist/react-native/tracingHelper.d.ts.map +1 -0
- package/dist/react-native/tracingHelper.js +198 -0
- package/dist/react-native/tracingHelper.js.map +1 -0
- package/dist/react-native/tracingPolicy.d.ts +12 -0
- package/dist/react-native/tracingPolicy.d.ts.map +1 -0
- package/dist/react-native/tracingPolicy.js +68 -0
- package/dist/react-native/tracingPolicy.js.map +1 -0
- package/package.json +26 -28
- package/CHANGELOG.md +0 -6
- package/review/ai-inference.api.md +0 -343
package/dist/esm/modelClient.js
CHANGED
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
// Copyright (c) Microsoft Corporation.
|
|
2
|
-
// Licensed under the MIT
|
|
2
|
+
// Licensed under the MIT License.
|
|
3
|
+
import { __rest } from "tslib";
|
|
3
4
|
import { getClient } from "@azure-rest/core-client";
|
|
4
5
|
import { logger } from "./logger.js";
|
|
5
|
-
import { isKeyCredential
|
|
6
|
+
import { isKeyCredential } from "@azure/core-auth";
|
|
7
|
+
import { tracingPolicy } from "./tracingPolicy.js";
|
|
6
8
|
/**
|
|
7
9
|
* Initialize a new instance of `ModelClient`
|
|
8
10
|
* @param endpointParam - The parameter endpointParam
|
|
9
11
|
* @param credentials - uniquely identify client credential
|
|
10
12
|
* @param options - the parameter for all optional parameters
|
|
11
13
|
*/
|
|
12
|
-
export default function createClient(endpointParam, credentials,
|
|
13
|
-
var
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
const userAgentInfo = `azsdk-js-ai-inference
|
|
14
|
+
export default function createClient(endpointParam, credentials, _a = {}) {
|
|
15
|
+
var _b, _c, _d, _e, _f, _g, _h, _j;
|
|
16
|
+
var { apiVersion = "2024-05-01-preview" } = _a, options = __rest(_a, ["apiVersion"]);
|
|
17
|
+
const endpointUrl = (_c = (_b = options.endpoint) !== null && _b !== void 0 ? _b : options.baseUrl) !== null && _c !== void 0 ? _c : `${endpointParam}`;
|
|
18
|
+
const userAgentInfo = `azsdk-js-ai-inference/1.0.0-beta.2`;
|
|
17
19
|
const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
|
|
18
20
|
? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
|
|
19
21
|
: `${userAgentInfo}`;
|
|
@@ -26,6 +28,25 @@ export default function createClient(endpointParam, credentials, options = {}) {
|
|
|
26
28
|
apiKeyHeaderName: (_j = (_h = options.credentials) === null || _h === void 0 ? void 0 : _h.apiKeyHeaderName) !== null && _j !== void 0 ? _j : "api-key",
|
|
27
29
|
} });
|
|
28
30
|
const client = getClient(endpointUrl, credentials, options);
|
|
31
|
+
client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
|
|
32
|
+
client.pipeline.addPolicy({
|
|
33
|
+
name: "InferenceTracingPolicy",
|
|
34
|
+
sendRequest: (req, next) => {
|
|
35
|
+
return tracingPolicy().sendRequest(req, next);
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
client.pipeline.addPolicy({
|
|
39
|
+
name: "ClientApiVersionPolicy",
|
|
40
|
+
sendRequest: (req, next) => {
|
|
41
|
+
// Use the apiVersion defined in request url directly
|
|
42
|
+
// Append one if there is no apiVersion and we have one at client options
|
|
43
|
+
const url = new URL(req.url);
|
|
44
|
+
if (!url.searchParams.get("api-version") && apiVersion) {
|
|
45
|
+
req.url = `${req.url}${Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"}api-version=${apiVersion}`;
|
|
46
|
+
}
|
|
47
|
+
return next(req);
|
|
48
|
+
},
|
|
49
|
+
});
|
|
29
50
|
if (isKeyCredential(credentials)) {
|
|
30
51
|
client.pipeline.addPolicy({
|
|
31
52
|
name: "customKeyCredentialPolicy",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"modelClient.js","sourceRoot":"","sources":["../../src/modelClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC
|
|
1
|
+
{"version":3,"file":"modelClient.js","sourceRoot":"","sources":["../../src/modelClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,OAAO,EAAE,SAAS,EAAiB,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAkC,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAQnD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4C,EAC5C,KAAwE,EAAE;;QAA1E,EAAE,UAAU,GAAG,oBAAoB,OAAuC,EAAlC,OAAO,cAA/C,cAAiD,CAAF;IAE/C,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,GAAG,aAAa,EAAE,CAAC;IAC9E,MAAM,aAAa,GAAG,oCAAoC,CAAC;IAC3D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,MAAM,CAAC,IAAI;SACtD,EACD,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,+BAA+B,CAAC;YACxE,gBAAgB,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,gBAAgB,mCAAI,SAAS;SACrE,GACF,CAAC;IAEF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAgB,CAAC;IAE3E,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,OAAO,aAAa,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KACF,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IACH,IAAI,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC;QACjC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;YACxB,IAAI,EAAE,2BAA2B;YACjC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI;gBAC7B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;gBAClE,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { getClient, ClientOptions } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport { TokenCredential, KeyCredential, isKeyCredential } from \"@azure/core-auth\";\nimport { ModelClient } from \"./clientDefinitions.js\";\nimport { tracingPolicy } from \"./tracingPolicy.js\";\n\n/** The optional parameters for the client */\nexport interface ModelClientOptions extends ClientOptions {\n /** The api version option of the client */\n apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `ModelClient`\n * @param endpointParam - The parameter endpointParam\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n endpointParam: string,\n credentials: TokenCredential | KeyCredential,\n { apiVersion = \"2024-05-01-preview\", ...options }: ModelClientOptions = {},\n): ModelClient {\n const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}`;\n const userAgentInfo = `azsdk-js-ai-inference/1.0.0-beta.2`;\n const userAgentPrefix =\n options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n : `${userAgentInfo}`;\n options = {\n ...options,\n userAgentOptions: {\n userAgentPrefix,\n },\n loggingOptions: {\n logger: options.loggingOptions?.logger ?? logger.info,\n },\n credentials: {\n scopes: options.credentials?.scopes ?? [\"https://ml.azure.com/.default\"],\n apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? \"api-key\",\n },\n };\n\n const client = getClient(endpointUrl, credentials, options) as ModelClient;\n\n client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n client.pipeline.addPolicy({\n name: \"InferenceTracingPolicy\",\n sendRequest: (req, next) => {\n return tracingPolicy().sendRequest(req, next);\n },\n });\n client.pipeline.addPolicy({\n name: \"ClientApiVersionPolicy\",\n sendRequest: (req, next) => {\n // Use the apiVersion defined in request url directly\n // Append one if there is no apiVersion and we have one at client options\n const url = new URL(req.url);\n if (!url.searchParams.get(\"api-version\") && apiVersion) {\n req.url = `${req.url}${\n Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n }api-version=${apiVersion}`;\n }\n\n return next(req);\n },\n });\n if (isKeyCredential(credentials)) {\n client.pipeline.addPolicy({\n name: \"customKeyCredentialPolicy\",\n async sendRequest(request, next) {\n request.headers.set(\"Authorization\", \"Bearer \" + credentials.key);\n return next(request);\n },\n });\n }\n\n return client;\n}\n"]}
|
package/dist/esm/models.d.ts
CHANGED
|
@@ -44,6 +44,8 @@ export interface ChatMessageImageUrl {
|
|
|
44
44
|
/**
|
|
45
45
|
* The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and
|
|
46
46
|
* accuracy.
|
|
47
|
+
*
|
|
48
|
+
* Possible values: "auto", "low", "high"
|
|
47
49
|
*/
|
|
48
50
|
detail?: ChatMessageImageDetailLevel;
|
|
49
51
|
}
|
|
@@ -59,23 +61,13 @@ export interface ChatRequestAssistantMessage extends ChatRequestMessageParent {
|
|
|
59
61
|
*/
|
|
60
62
|
tool_calls?: Array<ChatCompletionsToolCall>;
|
|
61
63
|
}
|
|
62
|
-
/**
|
|
63
|
-
|
|
64
|
-
* chat completion.
|
|
65
|
-
*/
|
|
66
|
-
export interface ChatCompletionsToolCallParent {
|
|
64
|
+
/** A function tool call requested by the AI model. */
|
|
65
|
+
export interface ChatCompletionsToolCall {
|
|
67
66
|
/** The ID of the tool call. */
|
|
68
67
|
id: string;
|
|
69
|
-
type
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents
|
|
73
|
-
* a function invocation needed for a subsequent chat completions request to resolve.
|
|
74
|
-
*/
|
|
75
|
-
export interface ChatCompletionsFunctionToolCall extends ChatCompletionsToolCallParent {
|
|
76
|
-
/** The type of tool call, in this case always 'function'. */
|
|
68
|
+
/** The type of tool call. Currently, only `function` is supported. */
|
|
77
69
|
type: "function";
|
|
78
|
-
/** The details of the function
|
|
70
|
+
/** The details of the function call requested by the AI model. */
|
|
79
71
|
function: FunctionCall;
|
|
80
72
|
}
|
|
81
73
|
/** The name and arguments of a function that should be called, as generated by the model. */
|
|
@@ -99,13 +91,31 @@ export interface ChatRequestToolMessage extends ChatRequestMessageParent {
|
|
|
99
91
|
/** The ID of the tool call resolved by the provided content. */
|
|
100
92
|
tool_call_id: string;
|
|
101
93
|
}
|
|
102
|
-
/**
|
|
103
|
-
|
|
94
|
+
/**
|
|
95
|
+
* Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode.
|
|
96
|
+
* Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON
|
|
97
|
+
* via a system or user message.
|
|
98
|
+
*/
|
|
99
|
+
export interface ChatCompletionsResponseFormatParent {
|
|
104
100
|
type: string;
|
|
105
101
|
}
|
|
106
|
-
/**
|
|
107
|
-
export interface
|
|
108
|
-
/**
|
|
102
|
+
/** A response format for Chat Completions that emits text responses. This is the default response format. */
|
|
103
|
+
export interface ChatCompletionsResponseFormatText extends ChatCompletionsResponseFormatParent {
|
|
104
|
+
/** Response format type: always 'text' for this object. */
|
|
105
|
+
type: "text";
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* A response format for Chat Completions that restricts responses to emitting valid JSON objects.
|
|
109
|
+
* Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON
|
|
110
|
+
* via a system or user message.
|
|
111
|
+
*/
|
|
112
|
+
export interface ChatCompletionsResponseFormatJSON extends ChatCompletionsResponseFormatParent {
|
|
113
|
+
/** Response format type: always 'json_object' for this object. */
|
|
114
|
+
type: "json_object";
|
|
115
|
+
}
|
|
116
|
+
/** The definition of a chat completions tool that can call a function. */
|
|
117
|
+
export interface ChatCompletionsToolDefinition {
|
|
118
|
+
/** The type of the tool. Currently, only `function` is supported. */
|
|
109
119
|
type: "function";
|
|
110
120
|
/** The function definition details for the function tool. */
|
|
111
121
|
function: FunctionDefinition;
|
|
@@ -122,13 +132,9 @@ export interface FunctionDefinition {
|
|
|
122
132
|
/** The parameters the function accepts, described as a JSON Schema object. */
|
|
123
133
|
parameters?: unknown;
|
|
124
134
|
}
|
|
125
|
-
/** An abstract representation of an explicit, named tool selection to use for a chat completions request. */
|
|
126
|
-
export interface ChatCompletionsNamedToolSelectionParent {
|
|
127
|
-
type: string;
|
|
128
|
-
}
|
|
129
135
|
/** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */
|
|
130
|
-
export interface
|
|
131
|
-
/** The
|
|
136
|
+
export interface ChatCompletionsNamedToolSelection {
|
|
137
|
+
/** The type of the tool. Currently, only `function` is supported. */
|
|
132
138
|
type: "function";
|
|
133
139
|
/** The function that should be called. */
|
|
134
140
|
function: ChatCompletionsFunctionToolSelection;
|
|
@@ -138,27 +144,36 @@ export interface ChatCompletionsFunctionToolSelection {
|
|
|
138
144
|
/** The name of the function that should be called. */
|
|
139
145
|
name: string;
|
|
140
146
|
}
|
|
147
|
+
/** Represents an image with optional text. */
|
|
148
|
+
export interface ImageEmbeddingInput {
|
|
149
|
+
/** The input image, in PNG format. */
|
|
150
|
+
image: string;
|
|
151
|
+
/**
|
|
152
|
+
* Optional. The text input to feed into the model (like DINO, CLIP).
|
|
153
|
+
* Returns a 422 error if the model doesn't support the value or parameter.
|
|
154
|
+
*/
|
|
155
|
+
text?: string;
|
|
156
|
+
}
|
|
141
157
|
/** An abstract representation of a chat message as provided in a request. */
|
|
142
158
|
export type ChatRequestMessage = ChatRequestMessageParent | ChatRequestSystemMessage | ChatRequestUserMessage | ChatRequestAssistantMessage | ChatRequestToolMessage;
|
|
143
159
|
/** An abstract representation of a structured content item within a chat message. */
|
|
144
160
|
export type ChatMessageContentItem = ChatMessageContentItemParent | ChatMessageTextContentItem | ChatMessageImageContentItem;
|
|
145
161
|
/**
|
|
146
|
-
*
|
|
147
|
-
*
|
|
162
|
+
* Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode.
|
|
163
|
+
* Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON
|
|
164
|
+
* via a system or user message.
|
|
148
165
|
*/
|
|
149
|
-
export type
|
|
150
|
-
/**
|
|
151
|
-
export type
|
|
152
|
-
/** An abstract representation of an explicit, named tool selection to use for a chat completions request. */
|
|
153
|
-
export type ChatCompletionsNamedToolSelection = ChatCompletionsNamedToolSelectionParent | ChatCompletionsNamedFunctionToolSelection;
|
|
154
|
-
/** Alias for UnknownParams */
|
|
155
|
-
export type UnknownParams = string | "error" | "drop" | "pass_through";
|
|
166
|
+
export type ChatCompletionsResponseFormat = ChatCompletionsResponseFormatParent | ChatCompletionsResponseFormatText | ChatCompletionsResponseFormatJSON;
|
|
167
|
+
/** Alias for ExtraParameters */
|
|
168
|
+
export type ExtraParameters = string;
|
|
156
169
|
/** Alias for ChatRole */
|
|
157
|
-
export type ChatRole = string
|
|
170
|
+
export type ChatRole = string;
|
|
158
171
|
/** Alias for ChatMessageImageDetailLevel */
|
|
159
|
-
export type ChatMessageImageDetailLevel = string
|
|
160
|
-
/** Alias for ChatCompletionsResponseFormat */
|
|
161
|
-
export type ChatCompletionsResponseFormat = string | "text" | "json_object";
|
|
172
|
+
export type ChatMessageImageDetailLevel = string;
|
|
162
173
|
/** Alias for ChatCompletionsToolSelectionPreset */
|
|
163
|
-
export type ChatCompletionsToolSelectionPreset = string
|
|
174
|
+
export type ChatCompletionsToolSelectionPreset = string;
|
|
175
|
+
/** Alias for EmbeddingEncodingFormat */
|
|
176
|
+
export type EmbeddingEncodingFormat = string;
|
|
177
|
+
/** Alias for EmbeddingInputType */
|
|
178
|
+
export type EmbeddingInputType = string;
|
|
164
179
|
//# sourceMappingURL=models.d.ts.map
|
package/dist/esm/models.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,6EAA6E;AAC7E,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,gGAAgG;IAChG,IAAI,EAAE,QAAQ,CAAC;IACf,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uEAAuE;AACvE,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;IACtE,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,8FAA8F;IAC9F,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACjD;AAED,qFAAqF;AACrF,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4DAA4D;AAC5D,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,6EAA6E;AAC7E,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,gGAAgG;IAChG,IAAI,EAAE,QAAQ,CAAC;IACf,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uEAAuE;AACvE,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;IACtE,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,8FAA8F;IAC9F,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACjD;AAED,qFAAqF;AACrF,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4DAA4D;AAC5D,MAAM,WAAW,0BAA2B,SAAQ,4BAA4B;IAC9E,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oEAAoE;AACpE,MAAM,WAAW,2BAA4B,SAAQ,4BAA4B;IAC/E,uEAAuE;IACvE,IAAI,EAAE,WAAW,CAAC;IAClB,yGAAyG;IACzG,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED,uEAAuE;AACvE,MAAM,WAAW,mBAAmB;IAClC,4BAA4B;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;OAKG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;CACtC;AAED,iFAAiF;AACjF,MAAM,WAAW,2BAA4B,SAAQ,wBAAwB;IAC3E,sGAAsG;IACtG,IAAI,EAAE,WAAW,CAAC;IAClB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;CAC7C;AAED,sDAAsD;AACtD,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,sEAAsE;IACtE,IAAI,EAAE,UAAU,CAAC;IACjB,kEAAkE;IAClE,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED,6FAA6F;AAC7F,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,mFAAmF;AACnF,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;IACtE,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gEAAgE;IAChE,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,6GAA6G;AAC7G,MAAM,WAAW,iCAAkC,SAAQ,mCAAmC;IAC5F,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAkC,SAAQ,mCAAmC;IAC5F,kEAAkE;IAClE,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,0EAA0E;AAC1E,MAAM,WAAW,6BAA6B;IAC5C,qEAAqE;IACrE,IAAI,EAAE,UAAU,CAAC;IACjB,6DAA6D;IAC7D,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,yHAAyH;AACzH,MAAM,WAAW,kBAAkB;IACjC,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,wHAAwH;AACxH,MAAM,WAAW,iCAAiC;IAChD,qEAAqE;IACrE,IAAI,EAAE,UAAU,CAAC;IACjB,0CAA0C;IAC1C,QAAQ,EAAE,oCAAoC,CAAC;CAChD;AAED,wHAAwH;AACxH,MAAM,WAAW,oCAAoC;IACnD,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IAClC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6EAA6E;AAC7E,MAAM,MAAM,kBAAkB,GAC1B,wBAAwB,GACxB,wBAAwB,GACxB,sBAAsB,GACtB,2BAA2B,GAC3B,sBAAsB,CAAC;AAC3B,qFAAqF;AACrF,MAAM,MAAM,sBAAsB,GAC9B,4BAA4B,GAC5B,0BAA0B,GAC1B,2BAA2B,CAAC;AAChC;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,mCAAmC,GACnC,iCAAiC,GACjC,iCAAiC,CAAC;AACtC,gCAAgC;AAChC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,yBAAyB;AACzB,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,4CAA4C;AAC5C,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC;AACjD,mDAAmD;AACnD,MAAM,MAAM,kCAAkC,GAAG,MAAM,CAAC;AACxD,wCAAwC;AACxC,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC7C,mCAAmC;AACnC,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC"}
|
package/dist/esm/models.js
CHANGED
package/dist/esm/models.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT
|
|
1
|
+
{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** An abstract representation of a chat message as provided in a request. */\nexport interface ChatRequestMessageParent {\n role: ChatRole;\n}\n\n/**\n * A request chat message containing system instructions that influence how the model will generate a chat completions\n * response.\n */\nexport interface ChatRequestSystemMessage extends ChatRequestMessageParent {\n /** The chat role associated with this message, which is always 'system' for system messages. */\n role: \"system\";\n /** The contents of the system message. */\n content: string;\n}\n\n/** A request chat message representing user input to the assistant. */\nexport interface ChatRequestUserMessage extends ChatRequestMessageParent {\n /** The chat role associated with this message, which is always 'user' for user messages. */\n role: \"user\";\n /** The contents of the user message, with available input types varying by selected model. */\n content: string | Array<ChatMessageContentItem>;\n}\n\n/** An abstract representation of a structured content item within a chat message. */\nexport interface ChatMessageContentItemParent {\n type: string;\n}\n\n/** A structured chat content item containing plain text. */\nexport interface ChatMessageTextContentItem extends ChatMessageContentItemParent {\n /** The discriminated object type: always 'text' for this type. */\n type: \"text\";\n /** The content of the message. */\n text: string;\n}\n\n/** A structured chat content item containing an image reference. */\nexport interface ChatMessageImageContentItem extends ChatMessageContentItemParent {\n /** The discriminated object type: always 'image_url' for this type. */\n type: \"image_url\";\n /** An internet location, which must be accessible to the model,from which the image may be retrieved. */\n image_url: ChatMessageImageUrl;\n}\n\n/** An internet location from which the model may retrieve an image. */\nexport interface ChatMessageImageUrl {\n /** The URL of the image. */\n url: string;\n /**\n * The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and\n * accuracy.\n *\n * Possible values: \"auto\", \"low\", \"high\"\n */\n detail?: ChatMessageImageDetailLevel;\n}\n\n/** A request chat message representing response or action from the assistant. */\nexport interface ChatRequestAssistantMessage extends ChatRequestMessageParent {\n /** The chat role associated with this message, which is always 'assistant' for assistant messages. */\n role: \"assistant\";\n /** The content of the message. */\n content?: string | null;\n /**\n * The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\n * completions request to resolve as configured.\n */\n tool_calls?: Array<ChatCompletionsToolCall>;\n}\n\n/** A function tool call requested by the AI model. */\nexport interface ChatCompletionsToolCall {\n /** The ID of the tool call. */\n id: string;\n /** The type of tool call. Currently, only `function` is supported. */\n type: \"function\";\n /** The details of the function call requested by the AI model. */\n function: FunctionCall;\n}\n\n/** The name and arguments of a function that should be called, as generated by the model. */\nexport interface FunctionCall {\n /** The name of the function to call. */\n name: string;\n /**\n * The arguments to call the function with, as generated by the model in JSON format.\n * Note that the model does not always generate valid JSON, and may hallucinate parameters\n * not defined by your function schema. Validate the arguments in your code before calling\n * your function.\n */\n arguments: string;\n}\n\n/** A request chat message representing requested output from a configured tool. */\nexport interface ChatRequestToolMessage extends ChatRequestMessageParent {\n /** The chat role associated with this message, which is always 'tool' for tool messages. */\n role: \"tool\";\n /** The content of the message. */\n content: string | null;\n /** The ID of the tool call resolved by the provided content. */\n tool_call_id: string;\n}\n\n/**\n * Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode.\n * Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\n * via a system or user message.\n */\nexport interface ChatCompletionsResponseFormatParent {\n type: string;\n}\n\n/** A response format for Chat Completions that emits text responses. This is the default response format. */\nexport interface ChatCompletionsResponseFormatText extends ChatCompletionsResponseFormatParent {\n /** Response format type: always 'text' for this object. */\n type: \"text\";\n}\n\n/**\n * A response format for Chat Completions that restricts responses to emitting valid JSON objects.\n * Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\n * via a system or user message.\n */\nexport interface ChatCompletionsResponseFormatJSON extends ChatCompletionsResponseFormatParent {\n /** Response format type: always 'json_object' for this object. */\n type: \"json_object\";\n}\n\n/** The definition of a chat completions tool that can call a function. */\nexport interface ChatCompletionsToolDefinition {\n /** The type of the tool. Currently, only `function` is supported. */\n type: \"function\";\n /** The function definition details for the function tool. */\n function: FunctionDefinition;\n}\n\n/** The definition of a caller-specified function that chat completions may invoke in response to matching user input. */\nexport interface FunctionDefinition {\n /** The name of the function to be called. */\n name: string;\n /**\n * A description of what the function does. The model will use this description when selecting the function and\n * interpreting its parameters.\n */\n description?: string;\n /** The parameters the function accepts, described as a JSON Schema object. */\n parameters?: unknown;\n}\n\n/** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */\nexport interface ChatCompletionsNamedToolSelection {\n /** The type of the tool. Currently, only `function` is supported. */\n type: \"function\";\n /** The function that should be called. */\n function: ChatCompletionsFunctionToolSelection;\n}\n\n/** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */\nexport interface ChatCompletionsFunctionToolSelection {\n /** The name of the function that should be called. */\n name: string;\n}\n\n/** Represents an image with optional text. */\nexport interface ImageEmbeddingInput {\n /** The input image, in PNG format. */\n image: string;\n /**\n * Optional. The text input to feed into the model (like DINO, CLIP).\n * Returns a 422 error if the model doesn't support the value or parameter.\n */\n text?: string;\n}\n\n/** An abstract representation of a chat message as provided in a request. */\nexport type ChatRequestMessage =\n | ChatRequestMessageParent\n | ChatRequestSystemMessage\n | ChatRequestUserMessage\n | ChatRequestAssistantMessage\n | ChatRequestToolMessage;\n/** An abstract representation of a structured content item within a chat message. */\nexport type ChatMessageContentItem =\n | ChatMessageContentItemParent\n | ChatMessageTextContentItem\n | ChatMessageImageContentItem;\n/**\n * Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode.\n * Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\n * via a system or user message.\n */\nexport type ChatCompletionsResponseFormat =\n | ChatCompletionsResponseFormatParent\n | ChatCompletionsResponseFormatText\n | ChatCompletionsResponseFormatJSON;\n/** Alias for ExtraParameters */\nexport type ExtraParameters = string;\n/** Alias for ChatRole */\nexport type ChatRole = string;\n/** Alias for ChatMessageImageDetailLevel */\nexport type ChatMessageImageDetailLevel = string;\n/** Alias for ChatCompletionsToolSelectionPreset */\nexport type ChatCompletionsToolSelectionPreset = string;\n/** Alias for EmbeddingEncodingFormat */\nexport type EmbeddingEncodingFormat = string;\n/** Alias for EmbeddingInputType */\nexport type EmbeddingInputType = string;\n"]}
|
|
@@ -1,20 +1,10 @@
|
|
|
1
|
-
/**
|
|
2
|
-
|
|
3
|
-
* chat completion.
|
|
4
|
-
*/
|
|
5
|
-
export interface ChatCompletionsToolCallOutputParent {
|
|
1
|
+
/** A function tool call requested by the AI model. */
|
|
2
|
+
export interface ChatCompletionsToolCallOutput {
|
|
6
3
|
/** The ID of the tool call. */
|
|
7
4
|
id: string;
|
|
8
|
-
type
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents
|
|
12
|
-
* a function invocation needed for a subsequent chat completions request to resolve.
|
|
13
|
-
*/
|
|
14
|
-
export interface ChatCompletionsFunctionToolCallOutput extends ChatCompletionsToolCallOutputParent {
|
|
15
|
-
/** The type of tool call, in this case always 'function'. */
|
|
5
|
+
/** The type of tool call. Currently, only `function` is supported. */
|
|
16
6
|
type: "function";
|
|
17
|
-
/** The details of the function
|
|
7
|
+
/** The details of the function call requested by the AI model. */
|
|
18
8
|
function: FunctionCallOutput;
|
|
19
9
|
}
|
|
20
10
|
/** The name and arguments of a function that should be called, as generated by the model. */
|
|
@@ -81,7 +71,11 @@ export interface ChatChoiceOutput {
|
|
|
81
71
|
}
|
|
82
72
|
/** A representation of a chat message as received in a response. */
|
|
83
73
|
export interface ChatResponseMessageOutput {
|
|
84
|
-
/**
|
|
74
|
+
/**
|
|
75
|
+
* The chat role associated with the message.
|
|
76
|
+
*
|
|
77
|
+
* Possible values: "system", "user", "assistant", "tool"
|
|
78
|
+
*/
|
|
85
79
|
role: ChatRoleOutput;
|
|
86
80
|
/** The content of the message. */
|
|
87
81
|
content: string | null;
|
|
@@ -95,20 +89,52 @@ export interface ChatResponseMessageOutput {
|
|
|
95
89
|
export interface ModelInfoOutput {
|
|
96
90
|
/** The name of the AI model. For example: `Phi21` */
|
|
97
91
|
model_name: string;
|
|
98
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* The type of the AI model. A Unique identifier for the profile.
|
|
94
|
+
*
|
|
95
|
+
* Possible values: "embeddings", "image_generation", "text_generation", "image_embeddings", "audio_generation", "chat"
|
|
96
|
+
*/
|
|
99
97
|
model_type: ModelTypeOutput;
|
|
100
98
|
/** The model provider name. For example: `Microsoft Research` */
|
|
101
99
|
model_provider_name: string;
|
|
102
100
|
}
|
|
103
101
|
/**
|
|
104
|
-
*
|
|
105
|
-
*
|
|
102
|
+
* Representation of the response data from an embeddings request.
|
|
103
|
+
* Embeddings measure the relatedness of text strings and are commonly used for search, clustering,
|
|
104
|
+
* recommendations, and other similar scenarios.
|
|
106
105
|
*/
|
|
107
|
-
export
|
|
106
|
+
export interface EmbeddingsResultOutput {
|
|
107
|
+
/** Embedding values for the prompts submitted in the request. */
|
|
108
|
+
data: Array<EmbeddingItemOutput>;
|
|
109
|
+
/** Usage counts for tokens input using the embeddings API. */
|
|
110
|
+
usage: EmbeddingsUsageOutput;
|
|
111
|
+
/** The model ID used to generate this result. */
|
|
112
|
+
model: string;
|
|
113
|
+
}
|
|
114
|
+
/** Representation of a single embeddings relatedness comparison. */
|
|
115
|
+
export interface EmbeddingItemOutput {
|
|
116
|
+
/**
|
|
117
|
+
* List of embedding values for the input prompt. These represent a measurement of the
|
|
118
|
+
* vector-based relatedness of the provided input. Or a base64 encoded string of the embedding vector.
|
|
119
|
+
*/
|
|
120
|
+
embedding: string | number[];
|
|
121
|
+
/** Index of the prompt to which the EmbeddingItem corresponds. */
|
|
122
|
+
index: number;
|
|
123
|
+
}
|
|
124
|
+
/** Measurement of the amount of tokens used in this request and response. */
|
|
125
|
+
export interface EmbeddingsUsageOutput {
|
|
126
|
+
/** Number of tokens in the request. */
|
|
127
|
+
prompt_tokens: number;
|
|
128
|
+
/**
|
|
129
|
+
* Total number of tokens transacted in this request/response. Should equal the
|
|
130
|
+
* number of tokens in the request.
|
|
131
|
+
*/
|
|
132
|
+
total_tokens: number;
|
|
133
|
+
}
|
|
108
134
|
/** Alias for ChatRoleOutput */
|
|
109
|
-
export type ChatRoleOutput = string
|
|
135
|
+
export type ChatRoleOutput = string;
|
|
110
136
|
/** Alias for CompletionsFinishReasonOutput */
|
|
111
|
-
export type CompletionsFinishReasonOutput = string
|
|
137
|
+
export type CompletionsFinishReasonOutput = string;
|
|
112
138
|
/** Alias for ModelTypeOutput */
|
|
113
|
-
export type ModelTypeOutput = string
|
|
139
|
+
export type ModelTypeOutput = string;
|
|
114
140
|
//# sourceMappingURL=outputModels.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA
|
|
1
|
+
{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,sDAAsD;AACtD,MAAM,WAAW,6BAA6B;IAC5C,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,sEAAsE;IACtE,IAAI,EAAE,UAAU,CAAC;IACjB,kEAAkE;IAClE,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,6FAA6F;AAC7F,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,0EAA0E;IAC1E,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,kGAAkG;IAClG,KAAK,EAAE,sBAAsB,CAAC;IAC9B;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,uEAAuE;IACvE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,aAAa,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,aAAa,EAAE,6BAA6B,GAAG,IAAI,CAAC;IACpD,4DAA4D;IAC5D,OAAO,EAAE,yBAAyB,CAAC;CACpC;AAED,oEAAoE;AACpE,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB,kCAAkC;IAClC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;CACnD;AAED,4DAA4D;AAC5D,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,UAAU,EAAE,eAAe,CAAC;IAC5B,iEAAiE;IACjE,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,iEAAiE;IACjE,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACjC,8DAA8D;IAC9D,KAAK,EAAE,qBAAqB,CAAC;IAC7B,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oEAAoE;AACpE,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAC;CACf;AAED,6EAA6E;AAC7E,MAAM,WAAW,qBAAqB;IACpC,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,8CAA8C;AAC9C,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,gCAAgC;AAChC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}
|
package/dist/esm/outputModels.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT
|
|
1
|
+
{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** A function tool call requested by the AI model. */\nexport interface ChatCompletionsToolCallOutput {\n /** The ID of the tool call. */\n id: string;\n /** The type of tool call. Currently, only `function` is supported. */\n type: \"function\";\n /** The details of the function call requested by the AI model. */\n function: FunctionCallOutput;\n}\n\n/** The name and arguments of a function that should be called, as generated by the model. */\nexport interface FunctionCallOutput {\n /** The name of the function to call. */\n name: string;\n /**\n * The arguments to call the function with, as generated by the model in JSON format.\n * Note that the model does not always generate valid JSON, and may hallucinate parameters\n * not defined by your function schema. Validate the arguments in your code before calling\n * your function.\n */\n arguments: string;\n}\n\n/**\n * Representation of the response data from a chat completions request.\n * Completions support a wide variety of tasks and generate text that continues from or \"completes\"\n * provided prompt data.\n */\nexport interface ChatCompletionsOutput {\n /** A unique identifier associated with this chat completions response. */\n id: string;\n /**\n * The first timestamp associated with generation activity for this completions response,\n * represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.\n */\n created: number;\n /** The model used for the chat completion. */\n model: string;\n /** Usage information for tokens processed and generated as part of this completions operation. */\n usage: CompletionsUsageOutput;\n /**\n * The collection of completions choices associated with this completions response.\n * Generally, `n` choices are generated per provided prompt with a default value of 1.\n * Token limits and other settings may limit the number of choices generated.\n */\n choices: Array<ChatChoiceOutput>;\n}\n\n/**\n * Representation of the token counts processed for a completions request.\n * Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and\n * other consumers.\n */\nexport interface CompletionsUsageOutput {\n /** The number of tokens generated across all completions emissions. */\n completion_tokens: number;\n /** The number of tokens in the provided prompts for the completions request. */\n prompt_tokens: number;\n /** The total number of tokens processed for the completions request and response. */\n total_tokens: number;\n}\n\n/**\n * The representation of a single prompt completion as part of an overall chat completions request.\n * Generally, `n` choices are generated per provided prompt with a default value of 1.\n * Token limits and other settings may limit the number of choices generated.\n */\nexport interface ChatChoiceOutput {\n /** The ordered index associated with this chat completions choice. */\n index: number;\n /** The reason that this chat completions choice completed its generated. */\n finish_reason: CompletionsFinishReasonOutput | null;\n /** The chat message for a given chat completions prompt. */\n message: ChatResponseMessageOutput;\n}\n\n/** A representation of a chat message as received in a response. */\nexport interface ChatResponseMessageOutput {\n /**\n * The chat role associated with the message.\n *\n * Possible values: \"system\", \"user\", \"assistant\", \"tool\"\n */\n role: ChatRoleOutput;\n /** The content of the message. */\n content: string | null;\n /**\n * The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\n * completions request to resolve as configured.\n */\n tool_calls?: Array<ChatCompletionsToolCallOutput>;\n}\n\n/** Represents some basic information about the AI model. */\nexport interface ModelInfoOutput {\n /** The name of the AI model. For example: `Phi21` */\n model_name: string;\n /**\n * The type of the AI model. A Unique identifier for the profile.\n *\n * Possible values: \"embeddings\", \"image_generation\", \"text_generation\", \"image_embeddings\", \"audio_generation\", \"chat\"\n */\n model_type: ModelTypeOutput;\n /** The model provider name. For example: `Microsoft Research` */\n model_provider_name: string;\n}\n\n/**\n * Representation of the response data from an embeddings request.\n * Embeddings measure the relatedness of text strings and are commonly used for search, clustering,\n * recommendations, and other similar scenarios.\n */\nexport interface EmbeddingsResultOutput {\n /** Embedding values for the prompts submitted in the request. */\n data: Array<EmbeddingItemOutput>;\n /** Usage counts for tokens input using the embeddings API. */\n usage: EmbeddingsUsageOutput;\n /** The model ID used to generate this result. */\n model: string;\n}\n\n/** Representation of a single embeddings relatedness comparison. */\nexport interface EmbeddingItemOutput {\n /**\n * List of embedding values for the input prompt. These represent a measurement of the\n * vector-based relatedness of the provided input. Or a base64 encoded string of the embedding vector.\n */\n embedding: string | number[];\n /** Index of the prompt to which the EmbeddingItem corresponds. */\n index: number;\n}\n\n/** Measurement of the amount of tokens used in this request and response. */\nexport interface EmbeddingsUsageOutput {\n /** Number of tokens in the request. */\n prompt_tokens: number;\n /**\n * Total number of tokens transacted in this request/response. Should equal the\n * number of tokens in the request.\n */\n total_tokens: number;\n}\n\n/** Alias for ChatRoleOutput */\nexport type ChatRoleOutput = string;\n/** Alias for CompletionsFinishReasonOutput */\nexport type CompletionsFinishReasonOutput = string;\n/** Alias for ModelTypeOutput */\nexport type ModelTypeOutput = string;\n"]}
|
package/dist/esm/parameters.d.ts
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { RawHttpHeadersInput } from "@azure/core-rest-pipeline";
|
|
2
2
|
import { RequestParameters } from "@azure-rest/core-client";
|
|
3
|
-
import {
|
|
3
|
+
import { ExtraParameters, ChatRequestMessage, ChatCompletionsResponseFormat, ChatCompletionsToolDefinition, ChatCompletionsToolSelectionPreset, ChatCompletionsNamedToolSelection, EmbeddingEncodingFormat, EmbeddingInputType, ImageEmbeddingInput } from "./models.js";
|
|
4
4
|
export interface GetChatCompletionsHeaders {
|
|
5
5
|
/**
|
|
6
|
-
* Controls what happens if
|
|
7
|
-
*
|
|
6
|
+
* Controls what happens if extra parameters, undefined by the REST API,
|
|
7
|
+
* are passed in the JSON request payload.
|
|
8
|
+
* This sets the HTTP request header `extra-parameters`.
|
|
9
|
+
*
|
|
10
|
+
* Possible values: "error", "drop", "pass-through"
|
|
8
11
|
*/
|
|
9
|
-
"
|
|
12
|
+
"extra-parameters"?: ExtraParameters;
|
|
10
13
|
}
|
|
11
14
|
export interface GetChatCompletionsBodyParam {
|
|
12
15
|
body?: {
|
|
@@ -30,4 +33,50 @@ export interface GetChatCompletionsHeaderParam {
|
|
|
30
33
|
}
|
|
31
34
|
export type GetChatCompletionsParameters = GetChatCompletionsHeaderParam & GetChatCompletionsBodyParam & RequestParameters;
|
|
32
35
|
export type GetModelInfoParameters = RequestParameters;
|
|
36
|
+
export interface GetEmbeddingsHeaders {
|
|
37
|
+
/**
|
|
38
|
+
* Controls what happens if extra parameters, undefined by the REST API,
|
|
39
|
+
* are passed in the JSON request payload.
|
|
40
|
+
* This sets the HTTP request header `extra-parameters`.
|
|
41
|
+
*
|
|
42
|
+
* Possible values: "error", "drop", "pass-through"
|
|
43
|
+
*/
|
|
44
|
+
"extra-parameters"?: ExtraParameters;
|
|
45
|
+
}
|
|
46
|
+
export interface GetEmbeddingsBodyParam {
|
|
47
|
+
body?: {
|
|
48
|
+
input: string[];
|
|
49
|
+
dimensions?: number;
|
|
50
|
+
encoding_format?: EmbeddingEncodingFormat;
|
|
51
|
+
input_type?: EmbeddingInputType;
|
|
52
|
+
model?: string;
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
export interface GetEmbeddingsHeaderParam {
|
|
56
|
+
headers?: RawHttpHeadersInput & GetEmbeddingsHeaders;
|
|
57
|
+
}
|
|
58
|
+
export type GetEmbeddingsParameters = GetEmbeddingsHeaderParam & GetEmbeddingsBodyParam & RequestParameters;
|
|
59
|
+
export interface GetImageEmbeddingsHeaders {
|
|
60
|
+
/**
|
|
61
|
+
* Controls what happens if extra parameters, undefined by the REST API,
|
|
62
|
+
* are passed in the JSON request payload.
|
|
63
|
+
* This sets the HTTP request header `extra-parameters`.
|
|
64
|
+
*
|
|
65
|
+
* Possible values: "error", "drop", "pass-through"
|
|
66
|
+
*/
|
|
67
|
+
"extra-parameters"?: ExtraParameters;
|
|
68
|
+
}
|
|
69
|
+
export interface GetImageEmbeddingsBodyParam {
|
|
70
|
+
body?: {
|
|
71
|
+
input: Array<ImageEmbeddingInput>;
|
|
72
|
+
dimensions?: number;
|
|
73
|
+
encoding_format?: EmbeddingEncodingFormat;
|
|
74
|
+
input_type?: EmbeddingInputType;
|
|
75
|
+
model?: string;
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
export interface GetImageEmbeddingsHeaderParam {
|
|
79
|
+
headers?: RawHttpHeadersInput & GetImageEmbeddingsHeaders;
|
|
80
|
+
}
|
|
81
|
+
export type GetImageEmbeddingsParameters = GetImageEmbeddingsHeaderParam & GetImageEmbeddingsBodyParam & RequestParameters;
|
|
33
82
|
//# sourceMappingURL=parameters.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EACL,
|
|
1
|
+
{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,6BAA6B,EAC7B,6BAA6B,EAC7B,kCAAkC,EAClC,iCAAiC,EACjC,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,yBAAyB;IACxC;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,eAAe,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,CAAC,EAAE;QACL,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,6BAA6B,CAAC;QAChD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,KAAK,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAC7C,WAAW,CAAC,EAAE,kCAAkC,GAAG,iCAAiC,CAAC;QACrF,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,mBAAmB,GAAG,yBAAyB,CAAC;CAC3D;AAED,MAAM,MAAM,4BAA4B,GAAG,6BAA6B,GACtE,2BAA2B,GAC3B,iBAAiB,CAAC;AACpB,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AAEvD,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,eAAe,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,uBAAuB,CAAC;QAC1C,UAAU,CAAC,EAAE,kBAAkB,CAAC;QAChC,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,CAAC,EAAE,mBAAmB,GAAG,oBAAoB,CAAC;CACtD;AAED,MAAM,MAAM,uBAAuB,GAAG,wBAAwB,GAC5D,sBAAsB,GACtB,iBAAiB,CAAC;AAEpB,MAAM,WAAW,yBAAyB;IACxC;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,eAAe,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAClC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,uBAAuB,CAAC;QAC1C,UAAU,CAAC,EAAE,kBAAkB,CAAC;QAChC,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,mBAAmB,GAAG,yBAAyB,CAAC;CAC3D;AAED,MAAM,MAAM,4BAA4B,GAAG,6BAA6B,GACtE,2BAA2B,GAC3B,iBAAiB,CAAC"}
|
package/dist/esm/parameters.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT
|
|
1
|
+
{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { RawHttpHeadersInput } from \"@azure/core-rest-pipeline\";\nimport { RequestParameters } from \"@azure-rest/core-client\";\nimport {\n ExtraParameters,\n ChatRequestMessage,\n ChatCompletionsResponseFormat,\n ChatCompletionsToolDefinition,\n ChatCompletionsToolSelectionPreset,\n ChatCompletionsNamedToolSelection,\n EmbeddingEncodingFormat,\n EmbeddingInputType,\n ImageEmbeddingInput,\n} from \"./models.js\";\n\nexport interface GetChatCompletionsHeaders {\n /**\n * Controls what happens if extra parameters, undefined by the REST API,\n * are passed in the JSON request payload.\n * This sets the HTTP request header `extra-parameters`.\n *\n * Possible values: \"error\", \"drop\", \"pass-through\"\n */\n \"extra-parameters\"?: ExtraParameters;\n}\n\nexport interface GetChatCompletionsBodyParam {\n body?: {\n messages: Array<ChatRequestMessage>;\n frequency_penalty?: number;\n stream?: boolean;\n presence_penalty?: number;\n temperature?: number;\n top_p?: number;\n max_tokens?: number;\n response_format?: ChatCompletionsResponseFormat;\n stop?: string[];\n tools?: Array<ChatCompletionsToolDefinition>;\n tool_choice?: ChatCompletionsToolSelectionPreset | ChatCompletionsNamedToolSelection;\n seed?: number;\n model?: string;\n };\n}\n\nexport interface GetChatCompletionsHeaderParam {\n headers?: RawHttpHeadersInput & GetChatCompletionsHeaders;\n}\n\nexport type GetChatCompletionsParameters = GetChatCompletionsHeaderParam &\n GetChatCompletionsBodyParam &\n RequestParameters;\nexport type GetModelInfoParameters = RequestParameters;\n\nexport interface GetEmbeddingsHeaders {\n /**\n * Controls what happens if extra parameters, undefined by the REST API,\n * are passed in the JSON request payload.\n * This sets the HTTP request header `extra-parameters`.\n *\n * Possible values: \"error\", \"drop\", \"pass-through\"\n */\n \"extra-parameters\"?: ExtraParameters;\n}\n\nexport interface GetEmbeddingsBodyParam {\n body?: {\n input: string[];\n dimensions?: number;\n encoding_format?: EmbeddingEncodingFormat;\n input_type?: EmbeddingInputType;\n model?: string;\n };\n}\n\nexport interface GetEmbeddingsHeaderParam {\n headers?: RawHttpHeadersInput & GetEmbeddingsHeaders;\n}\n\nexport type GetEmbeddingsParameters = GetEmbeddingsHeaderParam &\n GetEmbeddingsBodyParam &\n RequestParameters;\n\nexport interface GetImageEmbeddingsHeaders {\n /**\n * Controls what happens if extra parameters, undefined by the REST API,\n * are passed in the JSON request payload.\n * This sets the HTTP request header `extra-parameters`.\n *\n * Possible values: \"error\", \"drop\", \"pass-through\"\n */\n \"extra-parameters\"?: ExtraParameters;\n}\n\nexport interface GetImageEmbeddingsBodyParam {\n body?: {\n input: Array<ImageEmbeddingInput>;\n dimensions?: number;\n encoding_format?: EmbeddingEncodingFormat;\n input_type?: EmbeddingInputType;\n model?: string;\n };\n}\n\nexport interface GetImageEmbeddingsHeaderParam {\n headers?: RawHttpHeadersInput & GetImageEmbeddingsHeaders;\n}\n\nexport type GetImageEmbeddingsParameters = GetImageEmbeddingsHeaderParam &\n GetImageEmbeddingsBodyParam &\n RequestParameters;\n"]}
|
package/dist/esm/responses.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { RawHttpHeaders } from "@azure/core-rest-pipeline";
|
|
2
2
|
import { HttpResponse, ErrorResponse } from "@azure-rest/core-client";
|
|
3
|
-
import { ChatCompletionsOutput, ModelInfoOutput } from "./outputModels.js";
|
|
3
|
+
import { ChatCompletionsOutput, ModelInfoOutput, EmbeddingsResultOutput } from "./outputModels.js";
|
|
4
4
|
/** The request has succeeded. */
|
|
5
5
|
export interface GetChatCompletions200Response extends HttpResponse {
|
|
6
6
|
status: "200";
|
|
@@ -29,4 +29,32 @@ export interface GetModelInfoDefaultResponse extends HttpResponse {
|
|
|
29
29
|
body: ErrorResponse;
|
|
30
30
|
headers: RawHttpHeaders & GetModelInfoDefaultHeaders;
|
|
31
31
|
}
|
|
32
|
+
/** The request has succeeded. */
|
|
33
|
+
export interface GetEmbeddings200Response extends HttpResponse {
|
|
34
|
+
status: "200";
|
|
35
|
+
body: EmbeddingsResultOutput;
|
|
36
|
+
}
|
|
37
|
+
export interface GetEmbeddingsDefaultHeaders {
|
|
38
|
+
/** String error code indicating what went wrong. */
|
|
39
|
+
"x-ms-error-code"?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface GetEmbeddingsDefaultResponse extends HttpResponse {
|
|
42
|
+
status: string;
|
|
43
|
+
body: ErrorResponse;
|
|
44
|
+
headers: RawHttpHeaders & GetEmbeddingsDefaultHeaders;
|
|
45
|
+
}
|
|
46
|
+
/** The request has succeeded. */
|
|
47
|
+
export interface GetImageEmbeddings200Response extends HttpResponse {
|
|
48
|
+
status: "200";
|
|
49
|
+
body: EmbeddingsResultOutput;
|
|
50
|
+
}
|
|
51
|
+
export interface GetImageEmbeddingsDefaultHeaders {
|
|
52
|
+
/** String error code indicating what went wrong. */
|
|
53
|
+
"x-ms-error-code"?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface GetImageEmbeddingsDefaultResponse extends HttpResponse {
|
|
56
|
+
status: string;
|
|
57
|
+
body: ErrorResponse;
|
|
58
|
+
headers: RawHttpHeaders & GetImageEmbeddingsDefaultHeaders;
|
|
59
|
+
}
|
|
32
60
|
//# sourceMappingURL=responses.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAEnG,iCAAiC;AACjC,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IACjE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,MAAM,WAAW,gCAAgC;IAC/C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAkC,SAAQ,YAAY;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,gCAAgC,CAAC;CAC5D;AAED,iCAAiC;AACjC,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,0BAA0B,CAAC;CACtD;AAED,iCAAiC;AACjC,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,2BAA2B;IAC1C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,4BAA6B,SAAQ,YAAY;IAChE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,2BAA2B,CAAC;CACvD;AAED,iCAAiC;AACjC,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IACjE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,gCAAgC;IAC/C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAkC,SAAQ,YAAY;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,gCAAgC,CAAC;CAC5D"}
|