@osdk/typescript-sdk-docs 0.4.0-beta.1 → 0.4.0-beta.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @osdk/typescript-sdk-docs
 
+## 0.4.0-beta.3
+
+### Minor Changes
+
+- f38abb0: Nearest neighbor docs
+
+## 0.4.0-beta.2
+
+### Minor Changes
+
+- e9239a1: Add pivot docs.
+
 ## 0.3.0-beta.4
 
 ### Minor Changes

package/build/browser/generatedNoCheck/docsNoComputedVariables.js

@@ -330,7 +330,7 @@ export const snippets = {
           "computedVariables": ["linkedPrimaryKeyPropertyV2"]
         }],
         "loadLinkedObjectsReference": [{
-          "template": "import { {{linkedObjectType}} } from \"{{{packageName}}}\";\n\nfunction getLinked{{linkedObjectType}}(source: Osdk.Instance<{{sourceObjectType}}>) {\n    {{#isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchPageWithErrors({ $pageSize: 30 });\n    {{/isLinkManySided}}\n    {{^isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchOneWithErrors();\n    {{/isLinkManySided}}\n}"
+          "template": "import { {{linkedObjectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nfunction getLinked{{linkedObjectType}}(source: Osdk.Instance<{{sourceObjectType}}>) {\n    {{#isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchPageWithErrors({ $pageSize: 30 });\n    {{/isLinkManySided}}\n    {{^isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchOneWithErrors();\n    {{/isLinkManySided}}\n}\n\n// You can also get a linked object by doing an object set searcharound\nfunction getLinkedWithPivot{{linkedObjectType}}(){\n    return client({{sourceObjectType}}).pivotTo({{linkApiName}}).fetchPage();\n}"
         }],
         "aggregationTemplate": [{
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst num{{objectType}} = await client({{objectType}})\n    .where({{property}}: { $isNull : false }})\n    .aggregate({\n        $select: { $count: \"unordered\" },\n        $groupBy: { name: \"exact\" },\n    });"
@@ -566,6 +566,12 @@ export const snippets = {
         }],
         "derivedPropertyDatetimeExpression": [{
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}WithExpression = await client({{objectType}})\n    .withProperties({\n      \"newPropertyName\": (baseObjectSet) =>\n          {{^isExtractPart}} \n          baseObjectSet.pivotTo(\"{{linkName}}\")\n              .selectProperty(\"{{property}}\")\n              .{{operation}}(baseObjectSet.pivotTo(\"{{linkName}}\").selectProperty(\"{{property}}\"))\n          {{/isExtractPart}}\n          {{#isExtractPart}}\n          baseObjectSet.pivotTo(\"{{linkName}}\")\n              .selectProperty(\"{{property}}\").{{operation}}(\"DAY\")\n          {{/isExtractPart}}\n    });"
+        }],
+        "nearestNeighborsTextQuery": [{
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst result = await client({{objectType}})\n  .nearestNeighbors(\"coffee\", 5, \"{{vectorProperty}}\")\n  .fetchPage();"
+        }],
+        "nearestNeighborsVectorQuery": [{
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\n// Note that this vector maps to an arbitrary string\n// It must match the dimension of the \"{{vectorProperty}}\" property: {{vectorDimensionSize}}\nconst vector_query = Array.from({ length: {{vectorDimensionSize}} }, () => 0.3),\nconst result = await client({{objectType}})\n  .nearestNeighbors(vector_query, 5, \"{{vectorProperty}}\")\n  .fetchPage();"
         }]
       }
     }