feat: add semantic endpoints to plain client

Author: msieroslawska

lib/plain/common-types.ts

@@ -140,6 +140,10 @@ import type { FunctionLogPlainClientAPI } from './entities/function-log'
 import type { AiActionPlainClientAPI } from './entities/ai-action'
 import type { AiActionInvocationPlainClientAPI } from './entities/ai-action-invocation'
 import type { VectorizationStatusPlainClientAPI } from './entities/vectorization-status'
+import type { SemanticDuplicatesPlainClientAPI } from './entities/semantic-duplicates'
+import type { SemanticRecommendationsPlainClientAPI } from './entities/semantic-recommendations'
+import type { SemanticReferenceSuggestionsPlainClientAPI } from './entities/semantic-reference-suggestions'
+import type { SemanticSearchPlainClientAPI } from './entities/semantic-search'
 
 export type PlainClientAPI = {
   raw: {
@@ -690,4 +694,8 @@ export type PlainClientAPI = {
   workflowsChangelog: WorkflowsChangelogPlainClientAPI
   oauthApplication: OAuthApplicationPlainClientAPI
   vectorizationStatus: VectorizationStatusPlainClientAPI
+  semanticSearch: SemanticSearchPlainClientAPI
+  semanticDuplicates: SemanticDuplicatesPlainClientAPI
+  semanticRecommendations: SemanticRecommendationsPlainClientAPI
+  semanticReferenceSuggestions: SemanticReferenceSuggestionsPlainClientAPI
 }

lib/plain/entities/semantic-duplicates.ts

@@ -0,0 +1,22 @@
+import type {
+  GetSemanticDuplicatesProps,
+  SemanticDuplicatesProps,
+} from '../../entities/semantic-duplicates'
+import type { OptionalDefaults } from '../wrappers/wrap'
+import type { GetSpaceEnvironmentParams } from '../../common-types'
+import type { RawAxiosRequestHeaders } from 'axios'
+
+export type SemanticDuplicatesPlainClientAPI = {
+  /**
+   * Retrieves Semantic Duplicates for the given entity ID.
+   * @param params Parameters for getting the space and environment IDs.
+   * @param payload Payload containing entity ID and optional filters.
+   * @param headers Optional headers for the request.
+   * @returns A promise that resolves to Semantic Duplicates.
+   */
+  get(
+    params: OptionalDefaults<GetSpaceEnvironmentParams>,
+    payload: GetSemanticDuplicatesProps,
+    headers?: Partial<RawAxiosRequestHeaders>,
+  ): Promise<SemanticDuplicatesProps>
+}

lib/plain/entities/semantic-recommendations.ts

@@ -0,0 +1,22 @@
+import type {
+  GetSemanticRecommendationsProps,
+  SemanticRecommendationsProps,
+} from '../../entities/semantic-recommendations'
+import type { OptionalDefaults } from '../wrappers/wrap'
+import type { GetSpaceEnvironmentParams } from '../../common-types'
+import type { RawAxiosRequestHeaders } from 'axios'
+
+export type SemanticRecommendationsPlainClientAPI = {
+  /**
+   * Retrieves Semantic Recommendations for the given entity ID.
+   * @param params Parameters for getting the space and environment IDs.
+   * @param payload Payload containing entity ID and optional filters.
+   * @param headers Optional headers for the request.
+   * @returns A promise that resolves to Semantic Recommendations.
+   */
+  get(
+    params: OptionalDefaults<GetSpaceEnvironmentParams>,
+    payload: GetSemanticRecommendationsProps,
+    headers?: Partial<RawAxiosRequestHeaders>,
+  ): Promise<SemanticRecommendationsProps>
+}

lib/plain/entities/semantic-reference-suggestions.ts

@@ -0,0 +1,22 @@
+import type {
+  GetSemanticReferenceSuggestionsProps,
+  SemanticReferenceSuggestionsProps,
+} from '../../entities/semantic-reference-suggestions'
+import type { OptionalDefaults } from '../wrappers/wrap'
+import type { GetSpaceEnvironmentParams } from '../../common-types'
+import type { RawAxiosRequestHeaders } from 'axios'
+
+export type SemanticReferenceSuggestionsPlainClientAPI = {
+  /**
+   * Retrieves Semantic Reference Suggestions for the given entity ID and its reference field ID.
+   * @param params Parameters for getting the space and environment IDs.
+   * @param payload Payload containing entity ID, reference field ID and optional filters.
+   * @param headers Optional headers for the request.
+   * @returns A promise that resolves to Semantic Reference Suggestions.
+   */
+  get(
+    params: OptionalDefaults<GetSpaceEnvironmentParams>,
+    payload: GetSemanticReferenceSuggestionsProps,
+    headers?: Partial<RawAxiosRequestHeaders>,
+  ): Promise<SemanticReferenceSuggestionsProps>
+}

lib/plain/entities/semantic-search.ts

@@ -0,0 +1,19 @@
+import type { GetSemanticSearchProps, SemanticSearchProps } from '../../entities/semantic-search'
+import type { OptionalDefaults } from '../wrappers/wrap'
+import type { GetSpaceEnvironmentParams } from '../../common-types'
+import type { RawAxiosRequestHeaders } from 'axios'
+
+export type SemanticSearchPlainClientAPI = {
+  /**
+   * Retrieves Semantic Search results for the given query.
+   * @param params Parameters for getting the space and environment IDs.
+   * @param payload Payload containing query and optional filters.
+   * @param headers Optional headers for the request.
+   * @returns A promise that resolves to Semantic Search results.
+   */
+  get(
+    params: OptionalDefaults<GetSpaceEnvironmentParams>,
+    payload: GetSemanticSearchProps,
+    headers?: Partial<RawAxiosRequestHeaders>,
+  ): Promise<SemanticSearchProps>
+}

lib/plain/plain-client.ts

@@ -518,6 +518,18 @@ export const createPlainClient = (
       delete: wrap(wrapParams, 'OAuthApplication', 'delete'),
       create: wrap(wrapParams, 'OAuthApplication', 'create'),
     },
+    semanticDuplicates: {
+      get: wrap(wrapParams, 'SemanticDuplicates', 'get'),
+    },
+    semanticRecommendations: {
+      get: wrap(wrapParams, 'SemanticRecommendations', 'get'),
+    },
+    semanticReferenceSuggestions: {
+      get: wrap(wrapParams, 'SemanticReferenceSuggestions', 'get'),
+    },
+    semanticSearch: {
+      get: wrap(wrapParams, 'SemanticSearch', 'get'),
+    },
     spaceMember: {
       get: wrap(wrapParams, 'SpaceMember', 'get'),
       getMany: wrap(wrapParams, 'SpaceMember', 'getMany'),