[Do not merge] : [@azure/cosmos] Add Full text search support for cosmos-explorer

sdk/cosmosdb/ci.yml

@@ -35,3 +35,7 @@ extends:
     Artifacts:
       - name: azure-cosmos
         safeName: azurecosmos
+        skipPublishDocMs: true  
+        skipPublishDocGithubIo: true 
+        skipPublishDevFeed: true
+        skipUpdatePackageVersion: true 

sdk/cosmosdb/cosmos/CHANGELOG.md

@@ -1,14 +1,13 @@
 # Release History
 
-## 4.1.2 (Unreleased)
+## 4.2.0-beta.1 (2024-11-15)
 
 ### Features Added
+- Add support for Full text search and Hybrid Ranking.
 
-### Breaking Changes
-
-### Bugs Fixed
+- Addition of full text policy.
 
-### Other Changes
+- We have implemented support for Request Unit (RU) caps in Query operations. Clients can now seamlessly integrate RU caps into their fetch functions by specifying the desired cap within the operation options. If the specified RU cap is surpassed during the operation, clients will promptly receive an error notification, providing enhanced control and transparency over resource consumption.
 
 ## 4.1.1 (2024-08-30)
 

sdk/cosmosdb/cosmos/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/cosmos",
-  "version": "4.1.2",
+  "version": "4.2.0-beta.1",
   "description": "Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API",
   "sdk-type": "client",
   "keywords": [

sdk/cosmosdb/cosmos/review/cosmos.api.md

@@ -593,6 +593,7 @@ export const Constants: {
         MinimumInclusiveEffectivePartitionKey: string;
         MaximumExclusiveEffectivePartitionKey: string;
     };
+    NonStreamingQueryDefaultRUThreshold: number;
     AllVersionsAndDeletesChangeFeedWireFormatVersion: string;
     ChangeFeedIfNoneMatchStartFromNowHeader: string;
 };
@@ -634,6 +635,7 @@ export interface ContainerDefinition {
     computedProperties?: ComputedProperty[];
     conflictResolutionPolicy?: ConflictResolutionPolicy;
     defaultTtl?: number;
+    fullTextPolicy?: FullTextPolicy;
     geospatialConfig?: {
         type: GeospatialType;
     };
@@ -1095,6 +1097,23 @@ export class FeedResponse<TResource> {
     readonly resources: TResource[];
 }
 
+// @public
+export interface FullTextIndex {
+    path: string;
+}
+
+// @public
+export interface FullTextPath {
+    language: string;
+    path: string;
+}
+
+// @public
+export interface FullTextPolicy {
+    defaultLanguage: string;
+    fullTextPaths: FullTextPath[];
+}
+
 // @public (undocumented)
 export type GatewayStatistics = {
     activityId?: string;
@@ -1161,6 +1180,15 @@ export enum HTTPMethod {
     put = "PUT"
 }
 
+// @public
+export interface HybridSearchQueryInfo {
+    componentQueryInfos: QueryInfo[];
+    globalStatisticsQuery: string;
+    requiresGlobalStatistics: boolean;
+    skip: number;
+    take: number;
+}
+
 // @public (undocumented)
 export interface Index {
     // (undocumented)
@@ -1192,6 +1220,7 @@ export interface IndexingPolicy {
     automatic?: boolean;
     compositeIndexes?: CompositePath[][];
     excludedPaths?: IndexedPath[];
+    fullTextIndexes?: FullTextIndex[];
     includedPaths?: IndexedPath[];
     indexingMode?: keyof typeof IndexingMode;
     // (undocumented)
@@ -1452,10 +1481,11 @@ export type OperationWithItem = OperationBase & {
 
 // @public (undocumented)
 export interface PartitionedQueryExecutionInfo {
+    hybridSearchQueryInfo?: HybridSearchQueryInfo;
     // (undocumented)
     partitionedQueryExecutionInfoVersion: number;
     // (undocumented)
-    queryInfo: QueryInfo;
+    queryInfo?: QueryInfo;
     // (undocumented)
     queryRanges: QueryRange[];
 }
@@ -1671,11 +1701,11 @@ export interface QueryInfo {
 export class QueryIterator<T> {
     // Warning: (ae-forgotten-export) The symbol "FetchFunctionCallback" needs to be exported by the entry point index.d.ts
     constructor(clientContext: ClientContext, query: SqlQuerySpec | string, options: FeedOptions, fetchFunctions: FetchFunctionCallback | FetchFunctionCallback[], resourceLink?: string, resourceType?: ResourceType);
-    fetchAll(): Promise<FeedResponse<T>>;
+    fetchAll(options?: QueryOperationOptions): Promise<FeedResponse<T>>;
     // (undocumented)
-    fetchAllInternal(diagnosticNode: DiagnosticNodeInternal): Promise<FeedResponse<T>>;
-    fetchNext(): Promise<FeedResponse<T>>;
-    getAsyncIterator(): AsyncIterable<FeedResponse<T>>;
+    fetchAllInternal(diagnosticNode: DiagnosticNodeInternal, options?: QueryOperationOptions): Promise<FeedResponse<T>>;
+    fetchNext(options?: QueryOperationOptions): Promise<FeedResponse<T>>;
+    getAsyncIterator(options?: QueryOperationOptions): AsyncIterable<FeedResponse<T>>;
     hasMoreResults(): boolean;
     reset(): void;
 }
@@ -1764,6 +1794,11 @@ export const QueryMetricsConstants: {
     SchedulingMetricsText: string;
 };
 
+// @public (undocumented)
+export interface QueryOperationOptions {
+    ruCapPerOperation?: number;
+}
+
 // @public (undocumented)
 export class QueryPreparationTimes {
     constructor(queryCompilationTime: TimeSpan, logicalPlanBuildTime: TimeSpan, physicalPlanBuildTime: TimeSpan, queryOptimizationTime: TimeSpan);
@@ -2004,6 +2039,15 @@ export interface RetryOptions {
     maxWaitTimeInSeconds: number;
 }
 
+// @public (undocumented)
+export class RUCapPerOperationExceededError extends ErrorResponse {
+    constructor(message?: string, fetchedResults?: any[]);
+    // (undocumented)
+    readonly code: string;
+    // (undocumented)
+    fetchedResults: any[];
+}
+
 // @public (undocumented)
 export class RuntimeExecutionTimes {
     constructor(queryEngineExecutionTime: TimeSpan, systemFunctionExecutionTime: TimeSpan, userDefinedFunctionExecutionTime: TimeSpan);

sdk/cosmosdb/cosmos/src/client/Container/ContainerDefinition.ts

@@ -7,6 +7,7 @@ import { GeospatialType } from "../../documents/GeospatialType";
 import { ChangeFeedPolicy } from "../ChangeFeed/ChangeFeedPolicy";
 import { ComputedProperty } from "../../documents/ComputedProperty";
 import { VectorEmbeddingPolicy } from "../../documents/VectorEmbeddingPolicy";
+import { FullTextPolicy } from "../../documents/FullTextPolicy";
 
 export interface ContainerDefinition {
   /** The id of the container. */
@@ -31,4 +32,6 @@ export interface ContainerDefinition {
   computedProperties?: ComputedProperty[];
   /** The vector embedding policy information for storing items in a container. */
   vectorEmbeddingPolicy?: VectorEmbeddingPolicy;
+  /** The full text policy information for storing items in a container. */
+  fullTextPolicy?: FullTextPolicy;
 }

sdk/cosmosdb/cosmos/src/common/RUConsumedManager.ts

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import semaphore from "semaphore";
+
+/**
+ * @hidden
+ * @hidden
+ * Specifies Net RUConsumed
+ */
+export class RUConsumedManager {
+  private ruConsumed: number = 0;
+  private semaphore: any;
+
+  constructor() {
+    this.semaphore = semaphore(1);
+  }
+
+  getRUConsumed(): Promise<number> {
+    return new Promise((resolve) => {
+      this.semaphore.take(() => {
+        this.semaphore.leave();
+        resolve(this.ruConsumed);
+      });
+    });
+  }
+
+  addToRUConsumed(value: number): Promise<void> {
+    return new Promise((resolve) => {
+      this.semaphore.take(() => {
+        this.ruConsumed += value;
+        this.semaphore.leave();
+        resolve();
+      });
+    });
+  }
+}

sdk/cosmosdb/cosmos/src/common/constants.ts

@@ -204,7 +204,7 @@ export const Constants = {
   AzureNamespace: "Azure.Cosmos",
   AzurePackageName: "@azure/cosmos",
   SDKName: "azure-cosmos-js",
-  SDKVersion: "4.1.2",
+  SDKVersion: "4.2.0-beta.1",
 
   // Diagnostics
   CosmosDbDiagnosticLevelEnvVarName: "AZURE_COSMOSDB_DIAGNOSTICS_LEVEL",
@@ -261,7 +261,7 @@ export const Constants = {
     MinimumInclusiveEffectivePartitionKey: "",
     MaximumExclusiveEffectivePartitionKey: "FF",
   },
-
+  NonStreamingQueryDefaultRUThreshold: 5000,
   // Changefeed AllVersionsAndDeletesMode formatting version
   AllVersionsAndDeletesChangeFeedWireFormatVersion: "2021-09-15",
   ChangeFeedIfNoneMatchStartFromNowHeader: "*",
@@ -491,4 +491,6 @@ export enum QueryFeature {
   MultipleAggregates = "MultipleAggregates",
   NonStreamingOrderBy = "NonStreamingOrderBy",
   ListAndSetAggregate = "ListAndSetAggregate",
+  CountIf = "CountIf",
+  HybridSearch = "HybridSearch",
 }

sdk/cosmosdb/cosmos/src/common/index.ts

@@ -4,3 +4,4 @@ export * from "./constants";
 export * from "./helper";
 export * from "./statusCodes";
 export * from "./uriFactory";
+export { RUConsumedManager } from "./RUConsumedManager";

sdk/cosmosdb/cosmos/src/documents/FullTextPolicy.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+/**
+ * Represents a full text policy for a collection in the Azure Cosmos DB service.
+ */
+export interface FullTextPolicy {
+  /**
+   * The default language for the full text .
+   */
+  defaultLanguage: string;
+  /**
+   * The paths to be indexed for full text search.
+   */
+  fullTextPaths: FullTextPath[];
+}
+
+/**
+ * Represents a full text path to be indexed in the Azure Cosmos DB service.
+ */
+export interface FullTextPath {
+  /**
+   * The path to be indexed for full text search.
+   */
+  path: string;
+  /**
+   * The language for the full text path.
+   */
+  language: string;
+}

sdk/cosmosdb/cosmos/src/documents/IndexingPolicy.ts

@@ -15,6 +15,8 @@ export interface IndexingPolicy {
   vectorIndexes?: VectorIndex[];
   /** An array of {@link CompositeIndexes} representing composite indexes to be included. */
   compositeIndexes?: CompositePath[][];
+  /** An array of {@link FullTextIndex} representing full text indexes to be included. */
+  fullTextIndexes?: FullTextIndex[];
 }
 
 /* The target data type of a spatial path */
@@ -96,3 +98,11 @@ export interface CompositePath {
   /** The order of the composite index, either "ascending" or "descending". */
   order: "ascending" | "descending";
 }
+
+/**
+ * Represents a full text index in the indexing policy.
+ */
+export interface FullTextIndex {
+  /** The path in the JSON document to index. */
+  path: string;
+}

sdk/cosmosdb/cosmos/src/documents/index.ts

@@ -22,3 +22,4 @@ export * from "./UserDefinedFunctionType";
 export * from "./GeospatialType";
 export * from "./ComputedProperty";
 export * from "./VectorEmbeddingPolicy";
+export * from "./FullTextPolicy";

sdk/cosmosdb/cosmos/src/index.ts

@@ -68,6 +68,9 @@ export {
   VectorEmbeddingDataType,
   VectorEmbeddingDistanceFunction,
   VectorIndexType,
+  FullTextIndex,
+  FullTextPolicy,
+  FullTextPath,
 } from "./documents";
 
 export { UniqueKeyPolicy, UniqueKey } from "./client/Container/UniqueKeyPolicy";

sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/GlobalStatisticsAggregator.ts

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { GlobalStatistics } from "../../request/globalStatistics";
+import { Aggregator } from "./Aggregator";
+
+export class GlobalStatisticsAggregator implements Aggregator {
+  private globalStatistics: GlobalStatistics;
+
+  constructor() {
+    this.globalStatistics = {
+      documentCount: 0,
+      fullTextStatistics: [],
+    };
+  }
+
+  public aggregate(other: GlobalStatistics): void {
+    if (!other) {
+      return;
+    }
+    // Aggregate document count
+    this.globalStatistics.documentCount += other.documentCount;
+    // Ensure `fullTextStatistics` is initialized
+    if (!other.fullTextStatistics || other.fullTextStatistics.length === 0) {
+      return;
+    }
+
+    // Initialize `this.globalStatistics.fullTextStatistics` if it's empty
+    if (this.globalStatistics.fullTextStatistics.length === 0) {
+      this.globalStatistics.fullTextStatistics = other.fullTextStatistics.map((stat) => ({
+        totalWordCount: stat.totalWordCount,
+        hitCounts: [...stat.hitCounts],
+      }));
+    } else {
+      // Loop through `other.fullTextStatistics` to add values to `this.globalStatistics.fullTextStatistics`
+      for (let i = 0; i < other.fullTextStatistics.length; i++) {
+        const otherStat = other.fullTextStatistics[i];
+
+        // Ensure the index `i` is initialized
+        if (!this.globalStatistics.fullTextStatistics[i]) {
+          this.globalStatistics.fullTextStatistics[i] = {
+            totalWordCount: 0,
+            hitCounts: [],
+          };
+        }
+
+        // Add totalWordCount
+        this.globalStatistics.fullTextStatistics[i].totalWordCount += otherStat.totalWordCount;
+
+        // Aggregate `hitCounts`
+        for (let j = 0; j < otherStat.hitCounts.length; j++) {
+          // Initialize hit count if necessary
+          if (this.globalStatistics.fullTextStatistics[i].hitCounts.length <= j) {
+            this.globalStatistics.fullTextStatistics[i].hitCounts.push(0);
+          }
+          this.globalStatistics.fullTextStatistics[i].hitCounts[j] += otherStat.hitCounts[j];
+        }
+      }
+    }
+  }
+
+  public getResult(): GlobalStatistics {
+    return this.globalStatistics;
+  }
+}