@azure-rest/ai-inference 1.0.0-beta.1
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/CHANGELOG.md +6 -0
- package/LICENSE +21 -0
- package/README.md +429 -0
- package/dist/browser/clientDefinitions.d.ts +29 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js +4 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/index.d.ts +10 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +12 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +4 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/dist/browser/isUnexpected.js +72 -0
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/dist/browser/logger.js +5 -0
- package/dist/browser/logger.js.map +1 -0
- package/dist/browser/modelClient.d.ts +11 -0
- package/dist/browser/modelClient.d.ts.map +1 -0
- package/dist/browser/modelClient.js +40 -0
- package/dist/browser/modelClient.js.map +1 -0
- package/dist/browser/models.d.ts +164 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js +4 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/outputModels.d.ts +114 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js +4 -0
- package/dist/browser/outputModels.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/parameters.d.ts +33 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js +4 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/responses.d.ts +32 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js +4 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +29 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/index.d.ts +10 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +15 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +4 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +76 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/modelClient.d.ts +11 -0
- package/dist/commonjs/modelClient.d.ts.map +1 -0
- package/dist/commonjs/modelClient.js +43 -0
- package/dist/commonjs/modelClient.js.map +1 -0
- package/dist/commonjs/models.d.ts +164 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +114 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/parameters.d.ts +33 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/responses.d.ts +32 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/clientDefinitions.d.ts +29 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/index.d.ts +10 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +12 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +4 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +72 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/modelClient.d.ts +11 -0
- package/dist/esm/modelClient.d.ts.map +1 -0
- package/dist/esm/modelClient.js +40 -0
- package/dist/esm/modelClient.js.map +1 -0
- package/dist/esm/models.d.ts +164 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +114 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/parameters.d.ts +33 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/responses.d.ts +32 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +29 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/index.d.ts +10 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +12 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +4 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +72 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/modelClient.d.ts +11 -0
- package/dist/react-native/modelClient.d.ts.map +1 -0
- package/dist/react-native/modelClient.js +40 -0
- package/dist/react-native/modelClient.js.map +1 -0
- package/dist/react-native/models.d.ts +164 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +114 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/parameters.d.ts +33 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/responses.d.ts +32 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/package.json +148 -0
- package/review/ai-inference.api.md +343 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { RawHttpHeaders } from \"@azure/core-rest-pipeline\";\nimport { HttpResponse, ErrorResponse } from \"@azure-rest/core-client\";\nimport { ChatCompletionsOutput, ModelInfoOutput } from \"./outputModels.js\";\n\n/** The request has succeeded. */\nexport interface GetChatCompletions200Response extends HttpResponse {\n status: \"200\";\n body: ChatCompletionsOutput;\n}\n\nexport interface GetChatCompletionsDefaultHeaders {\n /** String error code indicating what went wrong. */\n \"x-ms-error-code\"?: string;\n}\n\nexport interface GetChatCompletionsDefaultResponse extends HttpResponse {\n status: string;\n body: ErrorResponse;\n headers: RawHttpHeaders & GetChatCompletionsDefaultHeaders;\n}\n\n/** The request has succeeded. */\nexport interface GetModelInfo200Response extends HttpResponse {\n status: \"200\";\n body: ModelInfoOutput;\n}\n\nexport interface GetModelInfoDefaultHeaders {\n /** String error code indicating what went wrong. */\n \"x-ms-error-code\"?: string;\n}\n\nexport interface GetModelInfoDefaultResponse extends HttpResponse {\n status: string;\n body: ErrorResponse;\n headers: RawHttpHeaders & GetModelInfoDefaultHeaders;\n}\n"]}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
|
|
2
|
+
// It should be published with your NPM package. It should not be tracked by Git.
|
|
3
|
+
{
|
|
4
|
+
"tsdocVersion": "0.12",
|
|
5
|
+
"toolPackages": [
|
|
6
|
+
{
|
|
7
|
+
"packageName": "@microsoft/api-extractor",
|
|
8
|
+
"packageVersion": "7.47.0"
|
|
9
|
+
}
|
|
10
|
+
]
|
|
11
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { GetChatCompletionsParameters, GetModelInfoParameters } from "./parameters.js";
|
|
2
|
+
import { GetChatCompletions200Response, GetChatCompletionsDefaultResponse, GetModelInfo200Response, GetModelInfoDefaultResponse } from "./responses.js";
|
|
3
|
+
import { Client, StreamableMethod } from "@azure-rest/core-client";
|
|
4
|
+
export interface GetChatCompletions {
|
|
5
|
+
/**
|
|
6
|
+
* Gets chat completions for the provided chat messages.
|
|
7
|
+
* Completions support a wide variety of tasks and generate text that continues from or "completes"
|
|
8
|
+
* provided prompt data. The method makes a REST API call to the `/chat/completions` route
|
|
9
|
+
* on the given endpoint.
|
|
10
|
+
*/
|
|
11
|
+
post(options?: GetChatCompletionsParameters): StreamableMethod<GetChatCompletions200Response | GetChatCompletionsDefaultResponse>;
|
|
12
|
+
}
|
|
13
|
+
export interface GetModelInfo {
|
|
14
|
+
/**
|
|
15
|
+
* Returns information about the AI model.
|
|
16
|
+
* The method makes a REST API call to the `/info` route on the given endpoint.
|
|
17
|
+
*/
|
|
18
|
+
get(options?: GetModelInfoParameters): StreamableMethod<GetModelInfo200Response | GetModelInfoDefaultResponse>;
|
|
19
|
+
}
|
|
20
|
+
export interface Routes {
|
|
21
|
+
/** Resource for '/chat/completions' has methods for the following verbs: post */
|
|
22
|
+
(path: "/chat/completions"): GetChatCompletions;
|
|
23
|
+
/** Resource for '/info' has methods for the following verbs: get */
|
|
24
|
+
(path: "/info"): GetModelInfo;
|
|
25
|
+
}
|
|
26
|
+
export type ModelClient = Client & {
|
|
27
|
+
path: Routes;
|
|
28
|
+
};
|
|
29
|
+
//# sourceMappingURL=clientDefinitions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,6BAA6B,EAC7B,iCAAiC,EACjC,uBAAuB,EACvB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,4BAA4B,GACrC,gBAAgB,CACjB,6BAA6B,GAAG,iCAAiC,CAClE,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,sBAAsB,GAC/B,gBAAgB,CAAC,uBAAuB,GAAG,2BAA2B,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,MAAM;IACrB,iFAAiF;IACjF,CAAC,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAChD,oEAAoE;IACpE,CAAC,IAAI,EAAE,OAAO,GAAG,YAAY,CAAC;CAC/B;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"clientDefinitions.js","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n GetChatCompletionsParameters,\n GetModelInfoParameters,\n} from \"./parameters.js\";\nimport {\n GetChatCompletions200Response,\n GetChatCompletionsDefaultResponse,\n GetModelInfo200Response,\n GetModelInfoDefaultResponse,\n} from \"./responses.js\";\nimport { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface GetChatCompletions {\n /**\n * Gets chat completions for the provided chat messages.\n * Completions support a wide variety of tasks and generate text that continues from or \"completes\"\n * provided prompt data. The method makes a REST API call to the `/chat/completions` route\n * on the given endpoint.\n */\n post(\n options?: GetChatCompletionsParameters,\n ): StreamableMethod<\n GetChatCompletions200Response | GetChatCompletionsDefaultResponse\n >;\n}\n\nexport interface GetModelInfo {\n /**\n * Returns information about the AI model.\n * The method makes a REST API call to the `/info` route on the given endpoint.\n */\n get(\n options?: GetModelInfoParameters,\n ): StreamableMethod<GetModelInfo200Response | GetModelInfoDefaultResponse>;\n}\n\nexport interface Routes {\n /** Resource for '/chat/completions' has methods for the following verbs: post */\n (path: \"/chat/completions\"): GetChatCompletions;\n /** Resource for '/info' has methods for the following verbs: get */\n (path: \"/info\"): GetModelInfo;\n}\n\nexport type ModelClient = Client & {\n path: Routes;\n};\n"]}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import ModelClient from "./modelClient.js";
|
|
2
|
+
export * from "./modelClient.js";
|
|
3
|
+
export * from "./parameters.js";
|
|
4
|
+
export * from "./responses.js";
|
|
5
|
+
export * from "./clientDefinitions.js";
|
|
6
|
+
export * from "./isUnexpected.js";
|
|
7
|
+
export * from "./models.js";
|
|
8
|
+
export * from "./outputModels.js";
|
|
9
|
+
export default ModelClient;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAE3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAElC,eAAe,WAAW,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import ModelClient from "./modelClient.js";
|
|
4
|
+
export * from "./modelClient.js";
|
|
5
|
+
export * from "./parameters.js";
|
|
6
|
+
export * from "./responses.js";
|
|
7
|
+
export * from "./clientDefinitions.js";
|
|
8
|
+
export * from "./isUnexpected.js";
|
|
9
|
+
export * from "./models.js";
|
|
10
|
+
export * from "./outputModels.js";
|
|
11
|
+
export default ModelClient;
|
|
12
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAE3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAElC,eAAe,WAAW,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport ModelClient from \"./modelClient.js\";\n\nexport * from \"./modelClient.js\";\nexport * from \"./parameters.js\";\nexport * from \"./responses.js\";\nexport * from \"./clientDefinitions.js\";\nexport * from \"./isUnexpected.js\";\nexport * from \"./models.js\";\nexport * from \"./outputModels.js\";\n\nexport default ModelClient;\n"]}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { GetChatCompletions200Response, GetChatCompletionsDefaultResponse, GetModelInfo200Response, GetModelInfoDefaultResponse } from "./responses.js";
|
|
2
|
+
export declare function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response is GetChatCompletionsDefaultResponse;
|
|
3
|
+
export declare function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response is GetModelInfoDefaultResponse;
|
|
4
|
+
//# sourceMappingURL=isUnexpected.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isUnexpected.d.ts","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,6BAA6B,EAC7B,iCAAiC,EACjC,uBAAuB,EACvB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AAOxB,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,6BAA6B,GAAG,iCAAiC,GAC1E,QAAQ,IAAI,iCAAiC,CAAC;AACjD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,uBAAuB,GAAG,2BAA2B,GAC9D,QAAQ,IAAI,2BAA2B,CAAC"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
const responseMap = {
|
|
4
|
+
"POST /chat/completions": ["200"],
|
|
5
|
+
"GET /info": ["200"],
|
|
6
|
+
};
|
|
7
|
+
export function isUnexpected(response) {
|
|
8
|
+
const lroOriginal = response.headers["x-ms-original-url"];
|
|
9
|
+
const url = new URL(lroOriginal !== null && lroOriginal !== void 0 ? lroOriginal : response.request.url);
|
|
10
|
+
const method = response.request.method;
|
|
11
|
+
let pathDetails = responseMap[`${method} ${url.pathname}`];
|
|
12
|
+
if (!pathDetails) {
|
|
13
|
+
pathDetails = getParametrizedPathSuccess(method, url.pathname);
|
|
14
|
+
}
|
|
15
|
+
return !pathDetails.includes(response.status);
|
|
16
|
+
}
|
|
17
|
+
function getParametrizedPathSuccess(method, path) {
|
|
18
|
+
var _a, _b, _c, _d;
|
|
19
|
+
const pathParts = path.split("/");
|
|
20
|
+
// Traverse list to match the longest candidate
|
|
21
|
+
// matchedLen: the length of candidate path
|
|
22
|
+
// matchedValue: the matched status code array
|
|
23
|
+
let matchedLen = -1, matchedValue = [];
|
|
24
|
+
// Iterate the responseMap to find a match
|
|
25
|
+
for (const [key, value] of Object.entries(responseMap)) {
|
|
26
|
+
// Extracting the path from the map key which is in format
|
|
27
|
+
// GET /path/foo
|
|
28
|
+
if (!key.startsWith(method)) {
|
|
29
|
+
continue;
|
|
30
|
+
}
|
|
31
|
+
const candidatePath = getPathFromMapKey(key);
|
|
32
|
+
// Get each part of the url path
|
|
33
|
+
const candidateParts = candidatePath.split("/");
|
|
34
|
+
// track if we have found a match to return the values found.
|
|
35
|
+
let found = true;
|
|
36
|
+
for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
|
|
37
|
+
if (((_a = candidateParts[i]) === null || _a === void 0 ? void 0 : _a.startsWith("{")) &&
|
|
38
|
+
((_b = candidateParts[i]) === null || _b === void 0 ? void 0 : _b.indexOf("}")) !== -1) {
|
|
39
|
+
const start = candidateParts[i].indexOf("}") + 1, end = (_c = candidateParts[i]) === null || _c === void 0 ? void 0 : _c.length;
|
|
40
|
+
// If the current part of the candidate is a "template" part
|
|
41
|
+
// Try to use the suffix of pattern to match the path
|
|
42
|
+
// {guid} ==> $
|
|
43
|
+
// {guid}:export ==> :export$
|
|
44
|
+
const isMatched = new RegExp(`${(_d = candidateParts[i]) === null || _d === void 0 ? void 0 : _d.slice(start, end)}`).test(pathParts[j] || "");
|
|
45
|
+
if (!isMatched) {
|
|
46
|
+
found = false;
|
|
47
|
+
break;
|
|
48
|
+
}
|
|
49
|
+
continue;
|
|
50
|
+
}
|
|
51
|
+
// If the candidate part is not a template and
|
|
52
|
+
// the parts don't match mark the candidate as not found
|
|
53
|
+
// to move on with the next candidate path.
|
|
54
|
+
if (candidateParts[i] !== pathParts[j]) {
|
|
55
|
+
found = false;
|
|
56
|
+
break;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
// We finished evaluating the current candidate parts
|
|
60
|
+
// Update the matched value if and only if we found the longer pattern
|
|
61
|
+
if (found && candidatePath.length > matchedLen) {
|
|
62
|
+
matchedLen = candidatePath.length;
|
|
63
|
+
matchedValue = value;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
return matchedValue;
|
|
67
|
+
}
|
|
68
|
+
function getPathFromMapKey(mapKey) {
|
|
69
|
+
const pathStart = mapKey.indexOf("/");
|
|
70
|
+
return mapKey.slice(pathStart);
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=isUnexpected.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AASlC,MAAM,WAAW,GAA6B;IAC5C,wBAAwB,EAAE,CAAC,KAAK,CAAC;IACjC,WAAW,EAAE,CAAC,KAAK,CAAC;CACrB,CAAC;AAQF,MAAM,UAAU,YAAY,CAC1B,QAI+B;IAE/B,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;IACvC,IAAI,WAAW,GAAG,WAAW,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAc,EAAE,IAAY;;IAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,+CAA+C;IAC/C,2CAA2C;IAC3C,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAAY,GAAa,EAAE,CAAC;IAE9B,0CAA0C;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7C,gCAAgC;QAChC,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,KACE,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAC3D,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAChB,CAAC,EAAE,EAAE,CAAC,EAAE,EACR,CAAC;YACD,IACE,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,UAAU,CAAC,GAAG,CAAC;gBAClC,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,GAAG,CAAC,MAAK,CAAC,CAAC,EACtC,CAAC;gBACD,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,MAAM,CAAC;gBAClC,4DAA4D;gBAC5D,qDAAqD;gBACrD,eAAe;gBACf,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,IAAI,MAAM,CAC1B,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAC1C,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAE3B,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n GetChatCompletions200Response,\n GetChatCompletionsDefaultResponse,\n GetModelInfo200Response,\n GetModelInfoDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n \"POST /chat/completions\": [\"200\"],\n \"GET /info\": [\"200\"],\n};\n\nexport function isUnexpected(\n response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse,\n): response is GetChatCompletionsDefaultResponse;\nexport function isUnexpected(\n response: GetModelInfo200Response | GetModelInfoDefaultResponse,\n): response is GetModelInfoDefaultResponse;\nexport function isUnexpected(\n response:\n | GetChatCompletions200Response\n | GetChatCompletionsDefaultResponse\n | GetModelInfo200Response\n | GetModelInfoDefaultResponse,\n): response is GetChatCompletionsDefaultResponse | GetModelInfoDefaultResponse {\n const lroOriginal = response.headers[\"x-ms-original-url\"];\n const url = new URL(lroOriginal ?? response.request.url);\n const method = response.request.method;\n let pathDetails = responseMap[`${method} ${url.pathname}`];\n if (!pathDetails) {\n pathDetails = getParametrizedPathSuccess(method, url.pathname);\n }\n return !pathDetails.includes(response.status);\n}\n\nfunction getParametrizedPathSuccess(method: string, path: string): string[] {\n const pathParts = path.split(\"/\");\n\n // Traverse list to match the longest candidate\n // matchedLen: the length of candidate path\n // matchedValue: the matched status code array\n let matchedLen = -1,\n matchedValue: string[] = [];\n\n // Iterate the responseMap to find a match\n for (const [key, value] of Object.entries(responseMap)) {\n // Extracting the path from the map key which is in format\n // GET /path/foo\n if (!key.startsWith(method)) {\n continue;\n }\n const candidatePath = getPathFromMapKey(key);\n // Get each part of the url path\n const candidateParts = candidatePath.split(\"/\");\n\n // track if we have found a match to return the values found.\n let found = true;\n for (\n let i = candidateParts.length - 1, j = pathParts.length - 1;\n i >= 1 && j >= 1;\n i--, j--\n ) {\n if (\n candidateParts[i]?.startsWith(\"{\") &&\n candidateParts[i]?.indexOf(\"}\") !== -1\n ) {\n const start = candidateParts[i]!.indexOf(\"}\") + 1,\n end = candidateParts[i]?.length;\n // If the current part of the candidate is a \"template\" part\n // Try to use the suffix of pattern to match the path\n // {guid} ==> $\n // {guid}:export ==> :export$\n const isMatched = new RegExp(\n `${candidateParts[i]?.slice(start, end)}`,\n ).test(pathParts[j] || \"\");\n\n if (!isMatched) {\n found = false;\n break;\n }\n continue;\n }\n\n // If the candidate part is not a template and\n // the parts don't match mark the candidate as not found\n // to move on with the next candidate path.\n if (candidateParts[i] !== pathParts[j]) {\n found = false;\n break;\n }\n }\n\n // We finished evaluating the current candidate parts\n // Update the matched value if and only if we found the longer pattern\n if (found && candidatePath.length > matchedLen) {\n matchedLen = candidatePath.length;\n matchedValue = value;\n }\n }\n\n return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n const pathStart = mapKey.indexOf(\"/\");\n return mapKey.slice(pathStart);\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM,qCAAqC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"@azure/logger\";\nexport const logger = createClientLogger(\"ai-inference\");\n"]}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ClientOptions } from "@azure-rest/core-client";
|
|
2
|
+
import { TokenCredential, KeyCredential } from "@azure/core-auth";
|
|
3
|
+
import { ModelClient } from "./clientDefinitions.js";
|
|
4
|
+
/**
|
|
5
|
+
* Initialize a new instance of `ModelClient`
|
|
6
|
+
* @param endpointParam - The parameter endpointParam
|
|
7
|
+
* @param credentials - uniquely identify client credential
|
|
8
|
+
* @param options - the parameter for all optional parameters
|
|
9
|
+
*/
|
|
10
|
+
export default function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): ModelClient;
|
|
11
|
+
//# sourceMappingURL=modelClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"modelClient.d.ts","sourceRoot":"","sources":["../../src/modelClient.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,EACL,eAAe,EACf,aAAa,EAEd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,eAAe,GAAG,aAAa,EAC5C,OAAO,GAAE,aAAkB,GAC1B,WAAW,CAmCb"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { getClient } from "@azure-rest/core-client";
|
|
4
|
+
import { logger } from "./logger.js";
|
|
5
|
+
import { isKeyCredential, } from "@azure/core-auth";
|
|
6
|
+
/**
|
|
7
|
+
* Initialize a new instance of `ModelClient`
|
|
8
|
+
* @param endpointParam - The parameter endpointParam
|
|
9
|
+
* @param credentials - uniquely identify client credential
|
|
10
|
+
* @param options - the parameter for all optional parameters
|
|
11
|
+
*/
|
|
12
|
+
export default function createClient(endpointParam, credentials, options = {}) {
|
|
13
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
14
|
+
const endpointUrl = (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUrl) !== null && _b !== void 0 ? _b : `${endpointParam}`;
|
|
15
|
+
options.apiVersion = (_c = options.apiVersion) !== null && _c !== void 0 ? _c : "2024-05-01-preview";
|
|
16
|
+
const userAgentInfo = `azsdk-js-ai-inference-rest/1.0.0-beta.1`;
|
|
17
|
+
const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
|
|
18
|
+
? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
|
|
19
|
+
: `${userAgentInfo}`;
|
|
20
|
+
options = Object.assign(Object.assign({}, options), { userAgentOptions: {
|
|
21
|
+
userAgentPrefix,
|
|
22
|
+
}, loggingOptions: {
|
|
23
|
+
logger: (_e = (_d = options.loggingOptions) === null || _d === void 0 ? void 0 : _d.logger) !== null && _e !== void 0 ? _e : logger.info,
|
|
24
|
+
}, credentials: {
|
|
25
|
+
scopes: (_g = (_f = options.credentials) === null || _f === void 0 ? void 0 : _f.scopes) !== null && _g !== void 0 ? _g : ["https://ml.azure.com/.default"],
|
|
26
|
+
apiKeyHeaderName: (_j = (_h = options.credentials) === null || _h === void 0 ? void 0 : _h.apiKeyHeaderName) !== null && _j !== void 0 ? _j : "api-key",
|
|
27
|
+
} });
|
|
28
|
+
const client = getClient(endpointUrl, credentials, options);
|
|
29
|
+
if (isKeyCredential(credentials)) {
|
|
30
|
+
client.pipeline.addPolicy({
|
|
31
|
+
name: "customKeyCredentialPolicy",
|
|
32
|
+
async sendRequest(request, next) {
|
|
33
|
+
request.headers.set("Authorization", "Bearer " + credentials.key);
|
|
34
|
+
return next(request);
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
return client;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=modelClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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,EAGL,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAG1B;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4C,EAC5C,UAAyB,EAAE;;IAE3B,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,GAAG,aAAa,EAAE,CAAC;IAC9E,OAAO,CAAC,UAAU,GAAG,MAAA,OAAO,CAAC,UAAU,mCAAI,oBAAoB,CAAC;IAChE,MAAM,aAAa,GAAG,yCAAyC,CAAC;IAChE,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,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 {\n TokenCredential,\n KeyCredential,\n isKeyCredential,\n} from \"@azure/core-auth\";\nimport { ModelClient } from \"./clientDefinitions.js\";\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 options: ClientOptions = {},\n): ModelClient {\n const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}`;\n options.apiVersion = options.apiVersion ?? \"2024-05-01-preview\";\n const userAgentInfo = `azsdk-js-ai-inference-rest/1.0.0-beta.1`;\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 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"]}
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/** An abstract representation of a chat message as provided in a request. */
|
|
2
|
+
export interface ChatRequestMessageParent {
|
|
3
|
+
role: ChatRole;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* A request chat message containing system instructions that influence how the model will generate a chat completions
|
|
7
|
+
* response.
|
|
8
|
+
*/
|
|
9
|
+
export interface ChatRequestSystemMessage extends ChatRequestMessageParent {
|
|
10
|
+
/** The chat role associated with this message, which is always 'system' for system messages. */
|
|
11
|
+
role: "system";
|
|
12
|
+
/** The contents of the system message. */
|
|
13
|
+
content: string;
|
|
14
|
+
}
|
|
15
|
+
/** A request chat message representing user input to the assistant. */
|
|
16
|
+
export interface ChatRequestUserMessage extends ChatRequestMessageParent {
|
|
17
|
+
/** The chat role associated with this message, which is always 'user' for user messages. */
|
|
18
|
+
role: "user";
|
|
19
|
+
/** The contents of the user message, with available input types varying by selected model. */
|
|
20
|
+
content: string | Array<ChatMessageContentItem>;
|
|
21
|
+
}
|
|
22
|
+
/** An abstract representation of a structured content item within a chat message. */
|
|
23
|
+
export interface ChatMessageContentItemParent {
|
|
24
|
+
type: string;
|
|
25
|
+
}
|
|
26
|
+
/** A structured chat content item containing plain text. */
|
|
27
|
+
export interface ChatMessageTextContentItem extends ChatMessageContentItemParent {
|
|
28
|
+
/** The discriminated object type: always 'text' for this type. */
|
|
29
|
+
type: "text";
|
|
30
|
+
/** The content of the message. */
|
|
31
|
+
text: string;
|
|
32
|
+
}
|
|
33
|
+
/** A structured chat content item containing an image reference. */
|
|
34
|
+
export interface ChatMessageImageContentItem extends ChatMessageContentItemParent {
|
|
35
|
+
/** The discriminated object type: always 'image_url' for this type. */
|
|
36
|
+
type: "image_url";
|
|
37
|
+
/** An internet location, which must be accessible to the model,from which the image may be retrieved. */
|
|
38
|
+
image_url: ChatMessageImageUrl;
|
|
39
|
+
}
|
|
40
|
+
/** An internet location from which the model may retrieve an image. */
|
|
41
|
+
export interface ChatMessageImageUrl {
|
|
42
|
+
/** The URL of the image. */
|
|
43
|
+
url: string;
|
|
44
|
+
/**
|
|
45
|
+
* The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and
|
|
46
|
+
* accuracy.
|
|
47
|
+
*/
|
|
48
|
+
detail?: ChatMessageImageDetailLevel;
|
|
49
|
+
}
|
|
50
|
+
/** A request chat message representing response or action from the assistant. */
|
|
51
|
+
export interface ChatRequestAssistantMessage extends ChatRequestMessageParent {
|
|
52
|
+
/** The chat role associated with this message, which is always 'assistant' for assistant messages. */
|
|
53
|
+
role: "assistant";
|
|
54
|
+
/** The content of the message. */
|
|
55
|
+
content?: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat
|
|
58
|
+
* completions request to resolve as configured.
|
|
59
|
+
*/
|
|
60
|
+
tool_calls?: Array<ChatCompletionsToolCall>;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested
|
|
64
|
+
* chat completion.
|
|
65
|
+
*/
|
|
66
|
+
export interface ChatCompletionsToolCallParent {
|
|
67
|
+
/** The ID of the tool call. */
|
|
68
|
+
id: string;
|
|
69
|
+
type: string;
|
|
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'. */
|
|
77
|
+
type: "function";
|
|
78
|
+
/** The details of the function invocation requested by the tool call. */
|
|
79
|
+
function: FunctionCall;
|
|
80
|
+
}
|
|
81
|
+
/** The name and arguments of a function that should be called, as generated by the model. */
|
|
82
|
+
export interface FunctionCall {
|
|
83
|
+
/** The name of the function to call. */
|
|
84
|
+
name: string;
|
|
85
|
+
/**
|
|
86
|
+
* The arguments to call the function with, as generated by the model in JSON format.
|
|
87
|
+
* Note that the model does not always generate valid JSON, and may hallucinate parameters
|
|
88
|
+
* not defined by your function schema. Validate the arguments in your code before calling
|
|
89
|
+
* your function.
|
|
90
|
+
*/
|
|
91
|
+
arguments: string;
|
|
92
|
+
}
|
|
93
|
+
/** A request chat message representing requested output from a configured tool. */
|
|
94
|
+
export interface ChatRequestToolMessage extends ChatRequestMessageParent {
|
|
95
|
+
/** The chat role associated with this message, which is always 'tool' for tool messages. */
|
|
96
|
+
role: "tool";
|
|
97
|
+
/** The content of the message. */
|
|
98
|
+
content: string | null;
|
|
99
|
+
/** The ID of the tool call resolved by the provided content. */
|
|
100
|
+
tool_call_id: string;
|
|
101
|
+
}
|
|
102
|
+
/** An abstract representation of a tool that can be used by the model to improve a chat completions response. */
|
|
103
|
+
export interface ChatCompletionsToolDefinitionParent {
|
|
104
|
+
type: string;
|
|
105
|
+
}
|
|
106
|
+
/** The definition information for a chat completions function tool that can call a function in response to a tool call. */
|
|
107
|
+
export interface ChatCompletionsFunctionToolDefinition extends ChatCompletionsToolDefinitionParent {
|
|
108
|
+
/** The object name, which is always 'function'. */
|
|
109
|
+
type: "function";
|
|
110
|
+
/** The function definition details for the function tool. */
|
|
111
|
+
function: FunctionDefinition;
|
|
112
|
+
}
|
|
113
|
+
/** The definition of a caller-specified function that chat completions may invoke in response to matching user input. */
|
|
114
|
+
export interface FunctionDefinition {
|
|
115
|
+
/** The name of the function to be called. */
|
|
116
|
+
name: string;
|
|
117
|
+
/**
|
|
118
|
+
* A description of what the function does. The model will use this description when selecting the function and
|
|
119
|
+
* interpreting its parameters.
|
|
120
|
+
*/
|
|
121
|
+
description?: string;
|
|
122
|
+
/** The parameters the function accepts, described as a JSON Schema object. */
|
|
123
|
+
parameters?: unknown;
|
|
124
|
+
}
|
|
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
|
+
/** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */
|
|
130
|
+
export interface ChatCompletionsNamedFunctionToolSelection extends ChatCompletionsNamedToolSelectionParent {
|
|
131
|
+
/** The object type, which is always 'function'. */
|
|
132
|
+
type: "function";
|
|
133
|
+
/** The function that should be called. */
|
|
134
|
+
function: ChatCompletionsFunctionToolSelection;
|
|
135
|
+
}
|
|
136
|
+
/** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */
|
|
137
|
+
export interface ChatCompletionsFunctionToolSelection {
|
|
138
|
+
/** The name of the function that should be called. */
|
|
139
|
+
name: string;
|
|
140
|
+
}
|
|
141
|
+
/** An abstract representation of a chat message as provided in a request. */
|
|
142
|
+
export type ChatRequestMessage = ChatRequestMessageParent | ChatRequestSystemMessage | ChatRequestUserMessage | ChatRequestAssistantMessage | ChatRequestToolMessage;
|
|
143
|
+
/** An abstract representation of a structured content item within a chat message. */
|
|
144
|
+
export type ChatMessageContentItem = ChatMessageContentItemParent | ChatMessageTextContentItem | ChatMessageImageContentItem;
|
|
145
|
+
/**
|
|
146
|
+
* An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested
|
|
147
|
+
* chat completion.
|
|
148
|
+
*/
|
|
149
|
+
export type ChatCompletionsToolCall = ChatCompletionsToolCallParent | ChatCompletionsFunctionToolCall;
|
|
150
|
+
/** An abstract representation of a tool that can be used by the model to improve a chat completions response. */
|
|
151
|
+
export type ChatCompletionsToolDefinition = ChatCompletionsToolDefinitionParent | ChatCompletionsFunctionToolDefinition;
|
|
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";
|
|
156
|
+
/** Alias for ChatRole */
|
|
157
|
+
export type ChatRole = string | "system" | "user" | "assistant" | "tool";
|
|
158
|
+
/** Alias for ChatMessageImageDetailLevel */
|
|
159
|
+
export type ChatMessageImageDetailLevel = string | "auto" | "low" | "high";
|
|
160
|
+
/** Alias for ChatCompletionsResponseFormat */
|
|
161
|
+
export type ChatCompletionsResponseFormat = string | "text" | "json_object";
|
|
162
|
+
/** Alias for ChatCompletionsToolSelectionPreset */
|
|
163
|
+
export type ChatCompletionsToolSelectionPreset = string | "auto" | "none" | "required";
|
|
164
|
+
//# sourceMappingURL=models.d.ts.map
|
|
@@ -0,0 +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,0BACf,SAAQ,4BAA4B;IACpC,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oEAAoE;AACpE,MAAM,WAAW,2BACf,SAAQ,4BAA4B;IACpC,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;;;OAGG;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;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,+BACf,SAAQ,6BAA6B;IACrC,6DAA6D;IAC7D,IAAI,EAAE,UAAU,CAAC;IACjB,yEAAyE;IACzE,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,iHAAiH;AACjH,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,2HAA2H;AAC3H,MAAM,WAAW,qCACf,SAAQ,mCAAmC;IAC3C,mDAAmD;IACnD,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,6GAA6G;AAC7G,MAAM,WAAW,uCAAuC;IACtD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,wHAAwH;AACxH,MAAM,WAAW,yCACf,SAAQ,uCAAuC;IAC/C,mDAAmD;IACnD,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,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;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAC/B,6BAA6B,GAC7B,+BAA+B,CAAC;AACpC,iHAAiH;AACjH,MAAM,MAAM,6BAA6B,GACrC,mCAAmC,GACnC,qCAAqC,CAAC;AAC1C,6GAA6G;AAC7G,MAAM,MAAM,iCAAiC,GACzC,uCAAuC,GACvC,yCAAyC,CAAC;AAC9C,8BAA8B;AAC9B,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,cAAc,CAAC;AACvE,yBAAyB;AACzB,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;AACzE,4CAA4C;AAC5C,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAC3E,8CAA8C;AAC9C,MAAM,MAAM,6BAA6B,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;AAC5E,mDAAmD;AACnD,MAAM,MAAM,kCAAkC,GAC1C,MAAM,GACN,MAAM,GACN,MAAM,GACN,UAAU,CAAC"}
|
|
@@ -0,0 +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 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\n 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\n 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 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/**\n * An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested\n * chat completion.\n */\nexport interface ChatCompletionsToolCallParent {\n /** The ID of the tool call. */\n id: string;\n type: string;\n}\n\n/**\n * A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\n * a function invocation needed for a subsequent chat completions request to resolve.\n */\nexport interface ChatCompletionsFunctionToolCall\n extends ChatCompletionsToolCallParent {\n /** The type of tool call, in this case always 'function'. */\n type: \"function\";\n /** The details of the function invocation requested by the tool call. */\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/** An abstract representation of a tool that can be used by the model to improve a chat completions response. */\nexport interface ChatCompletionsToolDefinitionParent {\n type: string;\n}\n\n/** The definition information for a chat completions function tool that can call a function in response to a tool call. */\nexport interface ChatCompletionsFunctionToolDefinition\n extends ChatCompletionsToolDefinitionParent {\n /** The object name, which is always 'function'. */\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/** An abstract representation of an explicit, named tool selection to use for a chat completions request. */\nexport interface ChatCompletionsNamedToolSelectionParent {\n type: string;\n}\n\n/** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */\nexport interface ChatCompletionsNamedFunctionToolSelection\n extends ChatCompletionsNamedToolSelectionParent {\n /** The object type, which is always 'function'. */\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/** 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 * An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested\n * chat completion.\n */\nexport type ChatCompletionsToolCall =\n | ChatCompletionsToolCallParent\n | ChatCompletionsFunctionToolCall;\n/** An abstract representation of a tool that can be used by the model to improve a chat completions response. */\nexport type ChatCompletionsToolDefinition =\n | ChatCompletionsToolDefinitionParent\n | ChatCompletionsFunctionToolDefinition;\n/** An abstract representation of an explicit, named tool selection to use for a chat completions request. */\nexport type ChatCompletionsNamedToolSelection =\n | ChatCompletionsNamedToolSelectionParent\n | ChatCompletionsNamedFunctionToolSelection;\n/** Alias for UnknownParams */\nexport type UnknownParams = string | \"error\" | \"drop\" | \"pass_through\";\n/** Alias for ChatRole */\nexport type ChatRole = string | \"system\" | \"user\" | \"assistant\" | \"tool\";\n/** Alias for ChatMessageImageDetailLevel */\nexport type ChatMessageImageDetailLevel = string | \"auto\" | \"low\" | \"high\";\n/** Alias for ChatCompletionsResponseFormat */\nexport type ChatCompletionsResponseFormat = string | \"text\" | \"json_object\";\n/** Alias for ChatCompletionsToolSelectionPreset */\nexport type ChatCompletionsToolSelectionPreset =\n | string\n | \"auto\"\n | \"none\"\n | \"required\";\n"]}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested
|
|
3
|
+
* chat completion.
|
|
4
|
+
*/
|
|
5
|
+
export interface ChatCompletionsToolCallOutputParent {
|
|
6
|
+
/** The ID of the tool call. */
|
|
7
|
+
id: string;
|
|
8
|
+
type: string;
|
|
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'. */
|
|
16
|
+
type: "function";
|
|
17
|
+
/** The details of the function invocation requested by the tool call. */
|
|
18
|
+
function: FunctionCallOutput;
|
|
19
|
+
}
|
|
20
|
+
/** The name and arguments of a function that should be called, as generated by the model. */
|
|
21
|
+
export interface FunctionCallOutput {
|
|
22
|
+
/** The name of the function to call. */
|
|
23
|
+
name: string;
|
|
24
|
+
/**
|
|
25
|
+
* The arguments to call the function with, as generated by the model in JSON format.
|
|
26
|
+
* Note that the model does not always generate valid JSON, and may hallucinate parameters
|
|
27
|
+
* not defined by your function schema. Validate the arguments in your code before calling
|
|
28
|
+
* your function.
|
|
29
|
+
*/
|
|
30
|
+
arguments: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Representation of the response data from a chat completions request.
|
|
34
|
+
* Completions support a wide variety of tasks and generate text that continues from or "completes"
|
|
35
|
+
* provided prompt data.
|
|
36
|
+
*/
|
|
37
|
+
export interface ChatCompletionsOutput {
|
|
38
|
+
/** A unique identifier associated with this chat completions response. */
|
|
39
|
+
id: string;
|
|
40
|
+
/**
|
|
41
|
+
* The first timestamp associated with generation activity for this completions response,
|
|
42
|
+
* represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
|
|
43
|
+
*/
|
|
44
|
+
created: number;
|
|
45
|
+
/** The model used for the chat completion. */
|
|
46
|
+
model: string;
|
|
47
|
+
/** Usage information for tokens processed and generated as part of this completions operation. */
|
|
48
|
+
usage: CompletionsUsageOutput;
|
|
49
|
+
/**
|
|
50
|
+
* The collection of completions choices associated with this completions response.
|
|
51
|
+
* Generally, `n` choices are generated per provided prompt with a default value of 1.
|
|
52
|
+
* Token limits and other settings may limit the number of choices generated.
|
|
53
|
+
*/
|
|
54
|
+
choices: Array<ChatChoiceOutput>;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Representation of the token counts processed for a completions request.
|
|
58
|
+
* Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and
|
|
59
|
+
* other consumers.
|
|
60
|
+
*/
|
|
61
|
+
export interface CompletionsUsageOutput {
|
|
62
|
+
/** The number of tokens generated across all completions emissions. */
|
|
63
|
+
completion_tokens: number;
|
|
64
|
+
/** The number of tokens in the provided prompts for the completions request. */
|
|
65
|
+
prompt_tokens: number;
|
|
66
|
+
/** The total number of tokens processed for the completions request and response. */
|
|
67
|
+
total_tokens: number;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* The representation of a single prompt completion as part of an overall chat completions request.
|
|
71
|
+
* Generally, `n` choices are generated per provided prompt with a default value of 1.
|
|
72
|
+
* Token limits and other settings may limit the number of choices generated.
|
|
73
|
+
*/
|
|
74
|
+
export interface ChatChoiceOutput {
|
|
75
|
+
/** The ordered index associated with this chat completions choice. */
|
|
76
|
+
index: number;
|
|
77
|
+
/** The reason that this chat completions choice completed its generated. */
|
|
78
|
+
finish_reason: CompletionsFinishReasonOutput | null;
|
|
79
|
+
/** The chat message for a given chat completions prompt. */
|
|
80
|
+
message: ChatResponseMessageOutput;
|
|
81
|
+
}
|
|
82
|
+
/** A representation of a chat message as received in a response. */
|
|
83
|
+
export interface ChatResponseMessageOutput {
|
|
84
|
+
/** The chat role associated with the message. */
|
|
85
|
+
role: ChatRoleOutput;
|
|
86
|
+
/** The content of the message. */
|
|
87
|
+
content: string | null;
|
|
88
|
+
/**
|
|
89
|
+
* The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat
|
|
90
|
+
* completions request to resolve as configured.
|
|
91
|
+
*/
|
|
92
|
+
tool_calls?: Array<ChatCompletionsToolCallOutput>;
|
|
93
|
+
}
|
|
94
|
+
/** Represents some basic information about the AI model. */
|
|
95
|
+
export interface ModelInfoOutput {
|
|
96
|
+
/** The name of the AI model. For example: `Phi21` */
|
|
97
|
+
model_name: string;
|
|
98
|
+
/** The type of the AI model. A Unique identifier for the profile. */
|
|
99
|
+
model_type: ModelTypeOutput;
|
|
100
|
+
/** The model provider name. For example: `Microsoft Research` */
|
|
101
|
+
model_provider_name: string;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested
|
|
105
|
+
* chat completion.
|
|
106
|
+
*/
|
|
107
|
+
export type ChatCompletionsToolCallOutput = ChatCompletionsToolCallOutputParent | ChatCompletionsFunctionToolCallOutput;
|
|
108
|
+
/** Alias for ChatRoleOutput */
|
|
109
|
+
export type ChatRoleOutput = string | "system" | "user" | "assistant" | "tool";
|
|
110
|
+
/** Alias for CompletionsFinishReasonOutput */
|
|
111
|
+
export type CompletionsFinishReasonOutput = string | "stop" | "length" | "content_filter" | "tool_calls";
|
|
112
|
+
/** Alias for ModelTypeOutput */
|
|
113
|
+
export type ModelTypeOutput = string | "embeddings" | "image_generation" | "text_generation" | "image_embeddings" | "audio_generation" | "chat";
|
|
114
|
+
//# sourceMappingURL=outputModels.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,qCACf,SAAQ,mCAAmC;IAC3C,6DAA6D;IAC7D,IAAI,EAAE,UAAU,CAAC;IACjB,yEAAyE;IACzE,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,iDAAiD;IACjD,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,qEAAqE;IACrE,UAAU,EAAE,eAAe,CAAC;IAC5B,iEAAiE;IACjE,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GACrC,mCAAmC,GACnC,qCAAqC,CAAC;AAC1C,+BAA+B;AAC/B,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;AAC/E,8CAA8C;AAC9C,MAAM,MAAM,6BAA6B,GACrC,MAAM,GACN,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,YAAY,CAAC;AACjB,gCAAgC;AAChC,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,YAAY,GACZ,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,GAClB,MAAM,CAAC"}
|