Fix tests + change WithOrderRelevance type

Author: mvanschellebeeck

etc/api.report.api.md

@@ -1300,9 +1300,8 @@ export type WhereClause<T extends ObjectOrInterfaceDefinition> = OrWhereClause<T
 export type WirePropertyTypes = BaseWirePropertyTypes | Record<string, BaseWirePropertyTypes>;
 
 // @public (undocumented)
-export type WithOrderByRelevance<T extends Osdk.Instance<any>> = {
+export type WithOrderByRelevance<T extends Osdk.Instance<any>> = T & {
     	$score: number
-    	object: T
 };
 
 // Warnings were encountered during analysis:

packages/api/src/OsdkObjectFrom.ts

@@ -190,9 +190,8 @@ export type Osdk<
       ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>
     >;
 
-export type WithOrderByRelevance<T extends Osdk.Instance<any>> = {
+export type WithOrderByRelevance<T extends Osdk.Instance<any>> = T & {
   $score: number;
-  object: T;
 };
 
 export namespace Osdk {
@@ -274,8 +273,3 @@ export type ExtractOptions<
   S extends NullabilityAdherence = NullabilityAdherence.Default,
   T extends boolean = false,
 > = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;
-
-export type ExtractOrderByOptions<R extends boolean> = IsNever<R> extends true
-  ? never
-  : DefaultToFalse<R> extends false ? never
-  : "$score";

packages/client.unstable/osdk-client.unstable-2.2.0-beta.9.tgz

@@ -210,7 +210,7 @@ describe("ObjectSet", () => {
     employees.forEach(e => expect(e.$score).toBeUndefined());
   });
 
-  it("nearest neighbors object set ordered by relevance", async () => {
+  it.only("nearest neighbors object set ordered by relevance", async () => {
     const objectSet = client(Employee);
     const { data: employees } = await objectSet.nearestNeighbors(
       "python3",

packages/client/src/objectSet/ObjectSet.test.ts

@@ -44,7 +44,7 @@ export async function runNearestNeighborsTest(): Promise<void> {
     });
   resultOrderedByRelevance.data.map(s => {
     invariant(s.$score !== undefined);
-    console.log(s.object.orderTitle, s.$score);
+    console.log(s.orderTitle, s.$score);
   });
 
   // Ensure regular ordering still works

packages/e2e.sandbox.catchall/src/runNearestNeighborsTest.ts

@@ -15,7 +15,9 @@
  */
 
 import type * as OntologiesV2 from "@osdk/foundry.ontologies";
+import stableStringify from "json-stable-stringify";
 import invariant from "tiny-invariant";
+import { nearestNeighborRequestHandlers } from "../stubs/nearestNeighborRequests.js";
 import type { BaseServerObject } from "./BaseServerObject.js";
 import type { FauxDataStore } from "./FauxDataStore.js";
 import { filterObjects } from "./filterObjects.js";
@@ -114,6 +116,10 @@ export function getObjectsFromSet(
       });
     }
 
+    case "nearestNeighbors": {
+      return nearestNeighborRequestHandlers[stableStringify(objectSet)];
+    }
+
     case "methodInput":
       invariant(methodInput, "expected a methodInput");
       return [methodInput];

packages/shared.test/src/FauxFoundry/getObjectsFromSet.ts

@@ -57,8 +57,13 @@ export const objectSetHandlers: Array<RequestHandler> = [
         };
       }
 
-      if (parsedBody.orderBy) {
-        objects = objects.sort(createOrderBySortFn(parsedBody.orderBy));
+      const orderBy = parsedBody.orderBy;
+      if (orderBy) {
+        if (orderBy?.orderType === "relevance") {
+          objects = objects.map(o => ({ ...o, "$score": 0.1 }));
+        } else {
+          objects = objects.sort(createOrderBySortFn(orderBy));
+        }
       }
 
       const page = pageThroughResponseSearchParams(

packages/shared.test/src/handlers/objectSetEndpoints.ts

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2023 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type * as OntologiesV2 from "@osdk/foundry.ontologies";
+import stableStringify from "json-stable-stringify";
+import type { BaseServerObject } from "../FauxFoundry/BaseServerObject.js";
+import { employee1, employee2, employee3 } from "./objects.js";
+import { employeeObjectType } from "./objectTypeV2.js";
+
+type NearestNeighborType = OntologiesV2.ObjectSetNearestNeighborsType & {
+  type: "nearestNeighbors";
+};
+
+const nearestNeighborsObjectSet: NearestNeighborType = {
+  type: "nearestNeighbors",
+  objectSet: {
+    type: "base",
+    objectType: employeeObjectType.apiName,
+  },
+  propertyIdentifier: {
+    type: "property",
+    apiName: "skillSetEmbedding",
+  },
+  numNeighbors: 3,
+  query: {
+    type: "text",
+    value: "python3",
+  },
+};
+
+const nearestNeighborsObjectSetVectorQuery: NearestNeighborType = {
+  type: "nearestNeighbors",
+  objectSet: {
+    type: "base",
+    objectType: employeeObjectType.apiName,
+  },
+  propertyIdentifier: {
+    type: "property",
+    apiName: "skillSetEmbedding",
+  },
+  numNeighbors: 3,
+  query: {
+    type: "vector",
+    value: Array.from({ length: 1536 }, () => 0.3),
+  },
+};
+
+export const nearestNeighborRequestHandlers: Record<
+  string,
+  BaseServerObject[]
+> = {
+  [stableStringify(nearestNeighborsObjectSet)]: [
+    employee1,
+    employee2,
+    employee3,
+  ],
+  [stableStringify(nearestNeighborsObjectSetVectorQuery)]: [
+    employee1,
+    employee2,
+    employee3,
+  ],
+};

packages/shared.test/src/stubs/nearestNeighborRequests.ts

@@ -15,7 +15,6 @@
  */
 
 import type { GeoJsonObject } from "@osdk/foundry.geo";
-import type { OntologyObjectV2 } from "@osdk/foundry.ontologies";
 import { employeeInterfaceScoped } from "./interfaces.js";
 
 export const employee50050: {
@@ -54,11 +53,6 @@ export const employee1 = {
 } as const;
 export const employee1_50030_JohnDoe: typeof employee1 = employee1;
 
-export const employee1WithScore: OntologyObjectV2 = {
-  ...employee1,
-  __score: 0.95,
-};
-
 export const employee2 = {
   __rid:
     "ri.phonograph2-objects.main.object.ae6a0b9a-9b9a-4b9e-8b0a-2b0b9a9a0b9a",
@@ -76,11 +70,6 @@ export const employee2 = {
 } as const;
 export const employee2_50031_JaneDoe: typeof employee2 = employee2;
 
-export const employee2WithScore: OntologyObjectV2 = {
-  ...employee1,
-  __score: 0.91,
-};
-
 export const employee3 = {
   __rid:
     "ri.phonograph2-objects.main.object.b9a0b2b0-0a2b-0b8b-9e4b-a9a9b9a0b9a0",
@@ -98,11 +87,6 @@ export const employee3 = {
 };
 export const employee3_Jack_50032: typeof employee3 = employee3;
 
-export const employee3WithScore: OntologyObjectV2 = {
-  ...employee1,
-  __score: 0.85,
-};
-
 // DELETE THIS
 export const employee4withDerived = {
   __rid: