@azure-rest/ai-inference 1.0.0-alpha.20241111.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.
Files changed (200) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +550 -0
  3. package/dist/browser/clientDefinitions.d.ts +47 -0
  4. package/dist/browser/clientDefinitions.d.ts.map +1 -0
  5. package/dist/browser/clientDefinitions.js +4 -0
  6. package/dist/browser/clientDefinitions.js.map +1 -0
  7. package/dist/browser/constants.d.ts +2 -0
  8. package/dist/browser/constants.d.ts.map +1 -0
  9. package/dist/browser/constants.js +4 -0
  10. package/dist/browser/constants.js.map +1 -0
  11. package/dist/browser/index.d.ts +10 -0
  12. package/dist/browser/index.d.ts.map +1 -0
  13. package/dist/browser/index.js +12 -0
  14. package/dist/browser/index.js.map +1 -0
  15. package/dist/browser/isUnexpected.d.ts +6 -0
  16. package/dist/browser/isUnexpected.d.ts.map +1 -0
  17. package/dist/browser/isUnexpected.js +73 -0
  18. package/dist/browser/isUnexpected.js.map +1 -0
  19. package/dist/browser/logger.d.ts +2 -0
  20. package/dist/browser/logger.d.ts.map +1 -0
  21. package/dist/browser/logger.js +5 -0
  22. package/dist/browser/logger.js.map +1 -0
  23. package/dist/browser/modelClient.d.ts +16 -0
  24. package/dist/browser/modelClient.d.ts.map +1 -0
  25. package/dist/browser/modelClient.js +61 -0
  26. package/dist/browser/modelClient.js.map +1 -0
  27. package/dist/browser/models.d.ts +179 -0
  28. package/dist/browser/models.d.ts.map +1 -0
  29. package/dist/browser/models.js +4 -0
  30. package/dist/browser/models.js.map +1 -0
  31. package/dist/browser/outputModels.d.ts +140 -0
  32. package/dist/browser/outputModels.d.ts.map +1 -0
  33. package/dist/browser/outputModels.js +4 -0
  34. package/dist/browser/outputModels.js.map +1 -0
  35. package/dist/browser/package.json +3 -0
  36. package/dist/browser/parameters.d.ts +82 -0
  37. package/dist/browser/parameters.d.ts.map +1 -0
  38. package/dist/browser/parameters.js +4 -0
  39. package/dist/browser/parameters.js.map +1 -0
  40. package/dist/browser/responses.d.ts +60 -0
  41. package/dist/browser/responses.d.ts.map +1 -0
  42. package/dist/browser/responses.js +4 -0
  43. package/dist/browser/responses.js.map +1 -0
  44. package/dist/browser/tracingHelper.d.ts +9 -0
  45. package/dist/browser/tracingHelper.d.ts.map +1 -0
  46. package/dist/browser/tracingHelper.js +198 -0
  47. package/dist/browser/tracingHelper.js.map +1 -0
  48. package/dist/browser/tracingPolicy.d.ts +12 -0
  49. package/dist/browser/tracingPolicy.d.ts.map +1 -0
  50. package/dist/browser/tracingPolicy.js +68 -0
  51. package/dist/browser/tracingPolicy.js.map +1 -0
  52. package/dist/commonjs/clientDefinitions.d.ts +47 -0
  53. package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
  54. package/dist/commonjs/clientDefinitions.js +5 -0
  55. package/dist/commonjs/clientDefinitions.js.map +1 -0
  56. package/dist/commonjs/constants.d.ts +2 -0
  57. package/dist/commonjs/constants.d.ts.map +1 -0
  58. package/dist/commonjs/constants.js +7 -0
  59. package/dist/commonjs/constants.js.map +1 -0
  60. package/dist/commonjs/index.d.ts +10 -0
  61. package/dist/commonjs/index.d.ts.map +1 -0
  62. package/dist/commonjs/index.js +15 -0
  63. package/dist/commonjs/index.js.map +1 -0
  64. package/dist/commonjs/isUnexpected.d.ts +6 -0
  65. package/dist/commonjs/isUnexpected.d.ts.map +1 -0
  66. package/dist/commonjs/isUnexpected.js +76 -0
  67. package/dist/commonjs/isUnexpected.js.map +1 -0
  68. package/dist/commonjs/logger.d.ts +2 -0
  69. package/dist/commonjs/logger.d.ts.map +1 -0
  70. package/dist/commonjs/logger.js +8 -0
  71. package/dist/commonjs/logger.js.map +1 -0
  72. package/dist/commonjs/modelClient.d.ts +16 -0
  73. package/dist/commonjs/modelClient.d.ts.map +1 -0
  74. package/dist/commonjs/modelClient.js +64 -0
  75. package/dist/commonjs/modelClient.js.map +1 -0
  76. package/dist/commonjs/models.d.ts +179 -0
  77. package/dist/commonjs/models.d.ts.map +1 -0
  78. package/dist/commonjs/models.js +5 -0
  79. package/dist/commonjs/models.js.map +1 -0
  80. package/dist/commonjs/outputModels.d.ts +140 -0
  81. package/dist/commonjs/outputModels.d.ts.map +1 -0
  82. package/dist/commonjs/outputModels.js +5 -0
  83. package/dist/commonjs/outputModels.js.map +1 -0
  84. package/dist/commonjs/package.json +3 -0
  85. package/dist/commonjs/parameters.d.ts +82 -0
  86. package/dist/commonjs/parameters.d.ts.map +1 -0
  87. package/dist/commonjs/parameters.js +5 -0
  88. package/dist/commonjs/parameters.js.map +1 -0
  89. package/dist/commonjs/responses.d.ts +60 -0
  90. package/dist/commonjs/responses.d.ts.map +1 -0
  91. package/dist/commonjs/responses.js +5 -0
  92. package/dist/commonjs/responses.js.map +1 -0
  93. package/dist/commonjs/tracingHelper.d.ts +9 -0
  94. package/dist/commonjs/tracingHelper.d.ts.map +1 -0
  95. package/dist/commonjs/tracingHelper.js +205 -0
  96. package/dist/commonjs/tracingHelper.js.map +1 -0
  97. package/dist/commonjs/tracingPolicy.d.ts +12 -0
  98. package/dist/commonjs/tracingPolicy.d.ts.map +1 -0
  99. package/dist/commonjs/tracingPolicy.js +72 -0
  100. package/dist/commonjs/tracingPolicy.js.map +1 -0
  101. package/dist/commonjs/tsdoc-metadata.json +11 -0
  102. package/dist/esm/clientDefinitions.d.ts +47 -0
  103. package/dist/esm/clientDefinitions.d.ts.map +1 -0
  104. package/dist/esm/clientDefinitions.js +4 -0
  105. package/dist/esm/clientDefinitions.js.map +1 -0
  106. package/dist/esm/constants.d.ts +2 -0
  107. package/dist/esm/constants.d.ts.map +1 -0
  108. package/dist/esm/constants.js +4 -0
  109. package/dist/esm/constants.js.map +1 -0
  110. package/dist/esm/index.d.ts +10 -0
  111. package/dist/esm/index.d.ts.map +1 -0
  112. package/dist/esm/index.js +12 -0
  113. package/dist/esm/index.js.map +1 -0
  114. package/dist/esm/isUnexpected.d.ts +6 -0
  115. package/dist/esm/isUnexpected.d.ts.map +1 -0
  116. package/dist/esm/isUnexpected.js +73 -0
  117. package/dist/esm/isUnexpected.js.map +1 -0
  118. package/dist/esm/logger.d.ts +2 -0
  119. package/dist/esm/logger.d.ts.map +1 -0
  120. package/dist/esm/logger.js +5 -0
  121. package/dist/esm/logger.js.map +1 -0
  122. package/dist/esm/modelClient.d.ts +16 -0
  123. package/dist/esm/modelClient.d.ts.map +1 -0
  124. package/dist/esm/modelClient.js +61 -0
  125. package/dist/esm/modelClient.js.map +1 -0
  126. package/dist/esm/models.d.ts +179 -0
  127. package/dist/esm/models.d.ts.map +1 -0
  128. package/dist/esm/models.js +4 -0
  129. package/dist/esm/models.js.map +1 -0
  130. package/dist/esm/outputModels.d.ts +140 -0
  131. package/dist/esm/outputModels.d.ts.map +1 -0
  132. package/dist/esm/outputModels.js +4 -0
  133. package/dist/esm/outputModels.js.map +1 -0
  134. package/dist/esm/package.json +3 -0
  135. package/dist/esm/parameters.d.ts +82 -0
  136. package/dist/esm/parameters.d.ts.map +1 -0
  137. package/dist/esm/parameters.js +4 -0
  138. package/dist/esm/parameters.js.map +1 -0
  139. package/dist/esm/responses.d.ts +60 -0
  140. package/dist/esm/responses.d.ts.map +1 -0
  141. package/dist/esm/responses.js +4 -0
  142. package/dist/esm/responses.js.map +1 -0
  143. package/dist/esm/tracingHelper.d.ts +9 -0
  144. package/dist/esm/tracingHelper.d.ts.map +1 -0
  145. package/dist/esm/tracingHelper.js +198 -0
  146. package/dist/esm/tracingHelper.js.map +1 -0
  147. package/dist/esm/tracingPolicy.d.ts +12 -0
  148. package/dist/esm/tracingPolicy.d.ts.map +1 -0
  149. package/dist/esm/tracingPolicy.js +68 -0
  150. package/dist/esm/tracingPolicy.js.map +1 -0
  151. package/dist/react-native/clientDefinitions.d.ts +47 -0
  152. package/dist/react-native/clientDefinitions.d.ts.map +1 -0
  153. package/dist/react-native/clientDefinitions.js +4 -0
  154. package/dist/react-native/clientDefinitions.js.map +1 -0
  155. package/dist/react-native/constants.d.ts +2 -0
  156. package/dist/react-native/constants.d.ts.map +1 -0
  157. package/dist/react-native/constants.js +4 -0
  158. package/dist/react-native/constants.js.map +1 -0
  159. package/dist/react-native/index.d.ts +10 -0
  160. package/dist/react-native/index.d.ts.map +1 -0
  161. package/dist/react-native/index.js +12 -0
  162. package/dist/react-native/index.js.map +1 -0
  163. package/dist/react-native/isUnexpected.d.ts +6 -0
  164. package/dist/react-native/isUnexpected.d.ts.map +1 -0
  165. package/dist/react-native/isUnexpected.js +73 -0
  166. package/dist/react-native/isUnexpected.js.map +1 -0
  167. package/dist/react-native/logger.d.ts +2 -0
  168. package/dist/react-native/logger.d.ts.map +1 -0
  169. package/dist/react-native/logger.js +5 -0
  170. package/dist/react-native/logger.js.map +1 -0
  171. package/dist/react-native/modelClient.d.ts +16 -0
  172. package/dist/react-native/modelClient.d.ts.map +1 -0
  173. package/dist/react-native/modelClient.js +61 -0
  174. package/dist/react-native/modelClient.js.map +1 -0
  175. package/dist/react-native/models.d.ts +179 -0
  176. package/dist/react-native/models.d.ts.map +1 -0
  177. package/dist/react-native/models.js +4 -0
  178. package/dist/react-native/models.js.map +1 -0
  179. package/dist/react-native/outputModels.d.ts +140 -0
  180. package/dist/react-native/outputModels.d.ts.map +1 -0
  181. package/dist/react-native/outputModels.js +4 -0
  182. package/dist/react-native/outputModels.js.map +1 -0
  183. package/dist/react-native/package.json +3 -0
  184. package/dist/react-native/parameters.d.ts +82 -0
  185. package/dist/react-native/parameters.d.ts.map +1 -0
  186. package/dist/react-native/parameters.js +4 -0
  187. package/dist/react-native/parameters.js.map +1 -0
  188. package/dist/react-native/responses.d.ts +60 -0
  189. package/dist/react-native/responses.d.ts.map +1 -0
  190. package/dist/react-native/responses.js +4 -0
  191. package/dist/react-native/responses.js.map +1 -0
  192. package/dist/react-native/tracingHelper.d.ts +9 -0
  193. package/dist/react-native/tracingHelper.d.ts.map +1 -0
  194. package/dist/react-native/tracingHelper.js +198 -0
  195. package/dist/react-native/tracingHelper.js.map +1 -0
  196. package/dist/react-native/tracingPolicy.d.ts +12 -0
  197. package/dist/react-native/tracingPolicy.d.ts.map +1 -0
  198. package/dist/react-native/tracingPolicy.js +68 -0
  199. package/dist/react-native/tracingPolicy.js.map +1 -0
  200. package/package.json +141 -0
@@ -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,6 @@
1
+ import type { GetChatCompletions200Response, GetChatCompletionsDefaultResponse, GetModelInfo200Response, GetModelInfoDefaultResponse, GetEmbeddings200Response, GetEmbeddingsDefaultResponse, GetImageEmbeddings200Response, GetImageEmbeddingsDefaultResponse } 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
+ export declare function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response is GetEmbeddingsDefaultResponse;
5
+ export declare function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response is GetImageEmbeddingsDefaultResponse;
6
+ //# sourceMappingURL=isUnexpected.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"isUnexpected.d.ts","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,6BAA6B,EAC7B,iCAAiC,EACjC,uBAAuB,EACvB,2BAA2B,EAC3B,wBAAwB,EACxB,4BAA4B,EAC5B,6BAA6B,EAC7B,iCAAiC,EAClC,MAAM,gBAAgB,CAAC;AASxB,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;AAC3C,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,wBAAwB,GAAG,4BAA4B,GAChE,QAAQ,IAAI,4BAA4B,CAAC;AAC5C,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,6BAA6B,GAAG,iCAAiC,GAC1E,QAAQ,IAAI,iCAAiC,CAAC"}
@@ -0,0 +1,73 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ const responseMap = {
4
+ "POST /chat/completions": ["200"],
5
+ "GET /info": ["200"],
6
+ "POST /embeddings": ["200"],
7
+ "POST /images/embeddings": ["200"],
8
+ };
9
+ export function isUnexpected(response) {
10
+ const lroOriginal = response.headers["x-ms-original-url"];
11
+ const url = new URL(lroOriginal !== null && lroOriginal !== void 0 ? lroOriginal : response.request.url);
12
+ const method = response.request.method;
13
+ let pathDetails = responseMap[`${method} ${url.pathname}`];
14
+ if (!pathDetails) {
15
+ pathDetails = getParametrizedPathSuccess(method, url.pathname);
16
+ }
17
+ return !pathDetails.includes(response.status);
18
+ }
19
+ function getParametrizedPathSuccess(method, path) {
20
+ var _a, _b, _c, _d;
21
+ const pathParts = path.split("/");
22
+ // Traverse list to match the longest candidate
23
+ // matchedLen: the length of candidate path
24
+ // matchedValue: the matched status code array
25
+ let matchedLen = -1, matchedValue = [];
26
+ // Iterate the responseMap to find a match
27
+ for (const [key, value] of Object.entries(responseMap)) {
28
+ // Extracting the path from the map key which is in format
29
+ // GET /path/foo
30
+ if (!key.startsWith(method)) {
31
+ continue;
32
+ }
33
+ const candidatePath = getPathFromMapKey(key);
34
+ // Get each part of the url path
35
+ const candidateParts = candidatePath.split("/");
36
+ // track if we have found a match to return the values found.
37
+ let found = true;
38
+ for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
39
+ if (((_a = candidateParts[i]) === null || _a === void 0 ? void 0 : _a.startsWith("{")) && ((_b = candidateParts[i]) === null || _b === void 0 ? void 0 : _b.indexOf("}")) !== -1) {
40
+ const start = candidateParts[i].indexOf("}") + 1, end = (_c = candidateParts[i]) === null || _c === void 0 ? void 0 : _c.length;
41
+ // If the current part of the candidate is a "template" part
42
+ // Try to use the suffix of pattern to match the path
43
+ // {guid} ==> $
44
+ // {guid}:export ==> :export$
45
+ const isMatched = new RegExp(`${(_d = candidateParts[i]) === null || _d === void 0 ? void 0 : _d.slice(start, end)}`).test(pathParts[j] || "");
46
+ if (!isMatched) {
47
+ found = false;
48
+ break;
49
+ }
50
+ continue;
51
+ }
52
+ // If the candidate part is not a template and
53
+ // the parts don't match mark the candidate as not found
54
+ // to move on with the next candidate path.
55
+ if (candidateParts[i] !== pathParts[j]) {
56
+ found = false;
57
+ break;
58
+ }
59
+ }
60
+ // We finished evaluating the current candidate parts
61
+ // Update the matched value if and only if we found the longer pattern
62
+ if (found && candidatePath.length > matchedLen) {
63
+ matchedLen = candidatePath.length;
64
+ matchedValue = value;
65
+ }
66
+ }
67
+ return matchedValue;
68
+ }
69
+ function getPathFromMapKey(mapKey) {
70
+ const pathStart = mapKey.indexOf("/");
71
+ return mapKey.slice(pathStart);
72
+ }
73
+ //# sourceMappingURL=isUnexpected.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAalC,MAAM,WAAW,GAA6B;IAC5C,wBAAwB,EAAE,CAAC,KAAK,CAAC;IACjC,WAAW,EAAE,CAAC,KAAK,CAAC;IACpB,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,yBAAyB,EAAE,CAAC,KAAK,CAAC;CACnC,CAAC;AAcF,MAAM,UAAU,YAAY,CAC1B,QAQqC;IAMrC,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,KAAK,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7F,IAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,UAAU,CAAC,GAAG,CAAC,KAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,GAAG,CAAC,MAAK,CAAC,CAAC,EAAE,CAAC;gBACjF,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,CAAC,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1E,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CACnB,CAAC;gBAEF,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 type {\n GetChatCompletions200Response,\n GetChatCompletionsDefaultResponse,\n GetModelInfo200Response,\n GetModelInfoDefaultResponse,\n GetEmbeddings200Response,\n GetEmbeddingsDefaultResponse,\n GetImageEmbeddings200Response,\n GetImageEmbeddingsDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n \"POST /chat/completions\": [\"200\"],\n \"GET /info\": [\"200\"],\n \"POST /embeddings\": [\"200\"],\n \"POST /images/embeddings\": [\"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: GetEmbeddings200Response | GetEmbeddingsDefaultResponse,\n): response is GetEmbeddingsDefaultResponse;\nexport function isUnexpected(\n response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse,\n): response is GetImageEmbeddingsDefaultResponse;\nexport function isUnexpected(\n response:\n | GetChatCompletions200Response\n | GetChatCompletionsDefaultResponse\n | GetModelInfo200Response\n | GetModelInfoDefaultResponse\n | GetEmbeddings200Response\n | GetEmbeddingsDefaultResponse\n | GetImageEmbeddings200Response\n | GetImageEmbeddingsDefaultResponse,\n): response is\n | GetChatCompletionsDefaultResponse\n | GetModelInfoDefaultResponse\n | GetEmbeddingsDefaultResponse\n | GetImageEmbeddingsDefaultResponse {\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 (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\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(`${candidateParts[i]?.slice(start, end)}`).test(\n pathParts[j] || \"\",\n );\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,2 @@
1
+ export declare const logger: import("@azure/logger").AzureLogger;
2
+ //# sourceMappingURL=logger.d.ts.map
@@ -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,5 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ import { createClientLogger } from "@azure/logger";
4
+ export const logger = createClientLogger("ai-inference");
5
+ //# sourceMappingURL=logger.js.map
@@ -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,16 @@
1
+ import type { ClientOptions } from "@azure-rest/core-client";
2
+ import type { TokenCredential, KeyCredential } from "@azure/core-auth";
3
+ import type { ModelClient } from "./clientDefinitions.js";
4
+ /** The optional parameters for the client */
5
+ export interface ModelClientOptions extends ClientOptions {
6
+ /** The api version option of the client */
7
+ apiVersion?: string;
8
+ }
9
+ /**
10
+ * Initialize a new instance of `ModelClient`
11
+ * @param endpointParam - The parameter endpointParam
12
+ * @param credentials - uniquely identify client credential
13
+ * @param options - the parameter for all optional parameters
14
+ */
15
+ export default function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, { apiVersion, ...options }?: ModelClientOptions): ModelClient;
16
+ //# sourceMappingURL=modelClient.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"modelClient.d.ts","sourceRoot":"","sources":["../../src/modelClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAG1D,6CAA6C;AAC7C,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,eAAe,GAAG,aAAa,EAC5C,EAAE,UAAiC,EAAE,GAAG,OAAO,EAAE,GAAE,kBAAuB,GACzE,WAAW,CAwDb"}
@@ -0,0 +1,61 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ import { __rest } from "tslib";
4
+ import { getClient } from "@azure-rest/core-client";
5
+ import { logger } from "./logger.js";
6
+ import { isKeyCredential } from "@azure/core-auth";
7
+ import { tracingPolicy } from "./tracingPolicy.js";
8
+ /**
9
+ * Initialize a new instance of `ModelClient`
10
+ * @param endpointParam - The parameter endpointParam
11
+ * @param credentials - uniquely identify client credential
12
+ * @param options - the parameter for all optional parameters
13
+ */
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`;
19
+ const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
20
+ ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
21
+ : `${userAgentInfo}`;
22
+ options = Object.assign(Object.assign({}, options), { userAgentOptions: {
23
+ userAgentPrefix,
24
+ }, loggingOptions: {
25
+ logger: (_e = (_d = options.loggingOptions) === null || _d === void 0 ? void 0 : _d.logger) !== null && _e !== void 0 ? _e : logger.info,
26
+ }, credentials: {
27
+ scopes: (_g = (_f = options.credentials) === null || _f === void 0 ? void 0 : _f.scopes) !== null && _g !== void 0 ? _g : ["https://ml.azure.com/.default"],
28
+ apiKeyHeaderName: (_j = (_h = options.credentials) === null || _h === void 0 ? void 0 : _h.apiKeyHeaderName) !== null && _j !== void 0 ? _j : "api-key",
29
+ } });
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
+ });
50
+ if (isKeyCredential(credentials)) {
51
+ client.pipeline.addPolicy({
52
+ name: "customKeyCredentialPolicy",
53
+ async sendRequest(request, next) {
54
+ request.headers.set("Authorization", "Bearer " + credentials.key);
55
+ return next(request);
56
+ },
57
+ });
58
+ }
59
+ return client;
60
+ }
61
+ //# sourceMappingURL=modelClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"modelClient.js","sourceRoot":"","sources":["../../src/modelClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD,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 type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport type { TokenCredential, KeyCredential } from \"@azure/core-auth\";\nimport { isKeyCredential } from \"@azure/core-auth\";\nimport type { 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"]}
@@ -0,0 +1,179 @@
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
+ * Possible values: "auto", "low", "high"
49
+ */
50
+ detail?: ChatMessageImageDetailLevel;
51
+ }
52
+ /** A request chat message representing response or action from the assistant. */
53
+ export interface ChatRequestAssistantMessage extends ChatRequestMessageParent {
54
+ /** The chat role associated with this message, which is always 'assistant' for assistant messages. */
55
+ role: "assistant";
56
+ /** The content of the message. */
57
+ content?: string | null;
58
+ /**
59
+ * The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat
60
+ * completions request to resolve as configured.
61
+ */
62
+ tool_calls?: Array<ChatCompletionsToolCall>;
63
+ }
64
+ /** A function tool call requested by the AI model. */
65
+ export interface ChatCompletionsToolCall {
66
+ /** The ID of the tool call. */
67
+ id: string;
68
+ /** The type of tool call. Currently, only `function` is supported. */
69
+ type: "function";
70
+ /** The details of the function call requested by the AI model. */
71
+ function: FunctionCall;
72
+ }
73
+ /** The name and arguments of a function that should be called, as generated by the model. */
74
+ export interface FunctionCall {
75
+ /** The name of the function to call. */
76
+ name: string;
77
+ /**
78
+ * The arguments to call the function with, as generated by the model in JSON format.
79
+ * Note that the model does not always generate valid JSON, and may hallucinate parameters
80
+ * not defined by your function schema. Validate the arguments in your code before calling
81
+ * your function.
82
+ */
83
+ arguments: string;
84
+ }
85
+ /** A request chat message representing requested output from a configured tool. */
86
+ export interface ChatRequestToolMessage extends ChatRequestMessageParent {
87
+ /** The chat role associated with this message, which is always 'tool' for tool messages. */
88
+ role: "tool";
89
+ /** The content of the message. */
90
+ content: string | null;
91
+ /** The ID of the tool call resolved by the provided content. */
92
+ tool_call_id: string;
93
+ }
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 {
100
+ type: string;
101
+ }
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. */
119
+ type: "function";
120
+ /** The function definition details for the function tool. */
121
+ function: FunctionDefinition;
122
+ }
123
+ /** The definition of a caller-specified function that chat completions may invoke in response to matching user input. */
124
+ export interface FunctionDefinition {
125
+ /** The name of the function to be called. */
126
+ name: string;
127
+ /**
128
+ * A description of what the function does. The model will use this description when selecting the function and
129
+ * interpreting its parameters.
130
+ */
131
+ description?: string;
132
+ /** The parameters the function accepts, described as a JSON Schema object. */
133
+ parameters?: unknown;
134
+ }
135
+ /** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */
136
+ export interface ChatCompletionsNamedToolSelection {
137
+ /** The type of the tool. Currently, only `function` is supported. */
138
+ type: "function";
139
+ /** The function that should be called. */
140
+ function: ChatCompletionsFunctionToolSelection;
141
+ }
142
+ /** A tool selection of a specific, named function tool that will limit chat completions to using the named function. */
143
+ export interface ChatCompletionsFunctionToolSelection {
144
+ /** The name of the function that should be called. */
145
+ name: string;
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
+ }
157
+ /** An abstract representation of a chat message as provided in a request. */
158
+ export type ChatRequestMessage = ChatRequestMessageParent | ChatRequestSystemMessage | ChatRequestUserMessage | ChatRequestAssistantMessage | ChatRequestToolMessage;
159
+ /** An abstract representation of a structured content item within a chat message. */
160
+ export type ChatMessageContentItem = ChatMessageContentItemParent | ChatMessageTextContentItem | ChatMessageImageContentItem;
161
+ /**
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.
165
+ */
166
+ export type ChatCompletionsResponseFormat = ChatCompletionsResponseFormatParent | ChatCompletionsResponseFormatText | ChatCompletionsResponseFormatJSON;
167
+ /** Alias for ExtraParameters */
168
+ export type ExtraParameters = string;
169
+ /** Alias for ChatRole */
170
+ export type ChatRole = string;
171
+ /** Alias for ChatMessageImageDetailLevel */
172
+ export type ChatMessageImageDetailLevel = string;
173
+ /** Alias for ChatCompletionsToolSelectionPreset */
174
+ export type ChatCompletionsToolSelectionPreset = string;
175
+ /** Alias for EmbeddingEncodingFormat */
176
+ export type EmbeddingEncodingFormat = string;
177
+ /** Alias for EmbeddingInputType */
178
+ export type EmbeddingInputType = string;
179
+ //# 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,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"}
@@ -0,0 +1,4 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ export {};
4
+ //# sourceMappingURL=models.js.map
@@ -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 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"]}
@@ -0,0 +1,140 @@
1
+ /** A function tool call requested by the AI model. */
2
+ export interface ChatCompletionsToolCallOutput {
3
+ /** The ID of the tool call. */
4
+ id: string;
5
+ /** The type of tool call. Currently, only `function` is supported. */
6
+ type: "function";
7
+ /** The details of the function call requested by the AI model. */
8
+ function: FunctionCallOutput;
9
+ }
10
+ /** The name and arguments of a function that should be called, as generated by the model. */
11
+ export interface FunctionCallOutput {
12
+ /** The name of the function to call. */
13
+ name: string;
14
+ /**
15
+ * The arguments to call the function with, as generated by the model in JSON format.
16
+ * Note that the model does not always generate valid JSON, and may hallucinate parameters
17
+ * not defined by your function schema. Validate the arguments in your code before calling
18
+ * your function.
19
+ */
20
+ arguments: string;
21
+ }
22
+ /**
23
+ * Representation of the response data from a chat completions request.
24
+ * Completions support a wide variety of tasks and generate text that continues from or "completes"
25
+ * provided prompt data.
26
+ */
27
+ export interface ChatCompletionsOutput {
28
+ /** A unique identifier associated with this chat completions response. */
29
+ id: string;
30
+ /**
31
+ * The first timestamp associated with generation activity for this completions response,
32
+ * represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
33
+ */
34
+ created: number;
35
+ /** The model used for the chat completion. */
36
+ model: string;
37
+ /** Usage information for tokens processed and generated as part of this completions operation. */
38
+ usage: CompletionsUsageOutput;
39
+ /**
40
+ * The collection of completions choices associated with this completions response.
41
+ * Generally, `n` choices are generated per provided prompt with a default value of 1.
42
+ * Token limits and other settings may limit the number of choices generated.
43
+ */
44
+ choices: Array<ChatChoiceOutput>;
45
+ }
46
+ /**
47
+ * Representation of the token counts processed for a completions request.
48
+ * Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and
49
+ * other consumers.
50
+ */
51
+ export interface CompletionsUsageOutput {
52
+ /** The number of tokens generated across all completions emissions. */
53
+ completion_tokens: number;
54
+ /** The number of tokens in the provided prompts for the completions request. */
55
+ prompt_tokens: number;
56
+ /** The total number of tokens processed for the completions request and response. */
57
+ total_tokens: number;
58
+ }
59
+ /**
60
+ * The representation of a single prompt completion as part of an overall chat completions request.
61
+ * Generally, `n` choices are generated per provided prompt with a default value of 1.
62
+ * Token limits and other settings may limit the number of choices generated.
63
+ */
64
+ export interface ChatChoiceOutput {
65
+ /** The ordered index associated with this chat completions choice. */
66
+ index: number;
67
+ /** The reason that this chat completions choice completed its generated. */
68
+ finish_reason: CompletionsFinishReasonOutput | null;
69
+ /** The chat message for a given chat completions prompt. */
70
+ message: ChatResponseMessageOutput;
71
+ }
72
+ /** A representation of a chat message as received in a response. */
73
+ export interface ChatResponseMessageOutput {
74
+ /**
75
+ * The chat role associated with the message.
76
+ *
77
+ * Possible values: "system", "user", "assistant", "tool"
78
+ */
79
+ role: ChatRoleOutput;
80
+ /** The content of the message. */
81
+ content: string | null;
82
+ /**
83
+ * The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat
84
+ * completions request to resolve as configured.
85
+ */
86
+ tool_calls?: Array<ChatCompletionsToolCallOutput>;
87
+ }
88
+ /** Represents some basic information about the AI model. */
89
+ export interface ModelInfoOutput {
90
+ /** The name of the AI model. For example: `Phi21` */
91
+ model_name: string;
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
+ */
97
+ model_type: ModelTypeOutput;
98
+ /** The model provider name. For example: `Microsoft Research` */
99
+ model_provider_name: string;
100
+ }
101
+ /**
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.
105
+ */
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
+ }
134
+ /** Alias for ChatRoleOutput */
135
+ export type ChatRoleOutput = string;
136
+ /** Alias for CompletionsFinishReasonOutput */
137
+ export type CompletionsFinishReasonOutput = string;
138
+ /** Alias for ModelTypeOutput */
139
+ export type ModelTypeOutput = string;
140
+ //# sourceMappingURL=outputModels.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,4 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ export {};
4
+ //# sourceMappingURL=outputModels.js.map
@@ -0,0 +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 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"]}
@@ -0,0 +1,3 @@
1
+ {
2
+ "type": "module"
3
+ }