Image type information (#626)

* added image types fields

* bump impresso-jscommons to v1.10.0; add image facet support (schema, types, solr mappings, resolvers, extractors, transformer, impressoPy)

Author: theorm

package-lock.json

@@ -88,7 +88,7 @@
     "graphology-metrics": "^2.3.1",
     "helmet": "^3.21.1",
     "http-proxy-middleware": "^3.0.5",
-    "impresso-jscommons": "github:impresso/impresso-jscommons#v1.9.0",
+    "impresso-jscommons": "github:impresso/impresso-jscommons#v1.10.0",
     "ioredis": "5.8.1",
     "json-bigint": "github:sidorares/json-bigint#8208aa1352eba252b60756672ab7c17f300d6ccd",
     "json2csv": "^4.3.3",

package.json

@@ -499,7 +499,10 @@ const trPassagesSolrMappings = {
   },
 } satisfies ISolrMappings<TextReusePassageFacet>
 
-export type ImageFacet = Extract<FilterType, 'newspaper' | 'year'>
+export type ImageFacet = Extract<
+  FilterType,
+  'newspaper' | 'year' | 'imageVisualContent' | 'imageTechnique' | 'imageCommunicationGoal' | 'imageContentType'
+>
 
 const imagesSolrMappings = {
   facets: {
@@ -517,6 +520,34 @@ const imagesSolrMappings = {
       limit: 400, // 400 years
       numBuckets: true,
     },
+    imageVisualContent: {
+      type: 'terms',
+      field: 'type_l0_tp',
+      mincount: 1,
+      limit: 20,
+      numBuckets: true,
+    },
+    imageTechnique: {
+      type: 'terms',
+      field: 'type_l1_tp',
+      mincount: 1,
+      limit: 20,
+      numBuckets: true,
+    },
+    imageCommunicationGoal: {
+      type: 'terms',
+      field: 'type_l2_tp',
+      mincount: 1,
+      limit: 20,
+      numBuckets: true,
+    },
+    imageContentType: {
+      type: 'terms',
+      field: 'type_l3_tp',
+      mincount: 1,
+      limit: 20,
+      numBuckets: true,
+    },
   },
 } satisfies ISolrMappings<ImageFacet>
 

src/data/constants.ts

@@ -14,6 +14,8 @@ import {
   Newspaper as INewspaper,
   Partner as IPartner,
 } from '../models/generated/schemas'
+import { FacetWithLabel } from '../models/generated/shared'
+import { ImageTypeValueLookup } from '../services/images/images.class'
 export type CachedFacetType =
   | 'newspaper'
   | 'topic'
@@ -24,7 +26,11 @@ export type CachedFacetType =
   | 'partner'
   | 'nag'
   | 'organisation'
-export type CachedFacetTypes = ITopic | IYear | IEntity | ICollection | INewspaper | IPartner
+  | 'imageVisualContent'
+  | 'imageTechnique'
+  | 'imageCommunicationGoal'
+  | 'imageContentType'
+export type CachedFacetTypes = ITopic | IYear | IEntity | ICollection | INewspaper | IPartner | FacetWithLabel
 
 export type IResolver<T> = (id: string) => Promise<T | undefined>
 
@@ -38,6 +44,10 @@ export type ICachedResolvers = {
   partner: IResolver<IPartner>
   nag: IResolver<IEntity>
   organisation: IResolver<IEntity>
+  imageVisualContent: IResolver<FacetWithLabel>
+  imageTechnique: IResolver<FacetWithLabel>
+  imageCommunicationGoal: IResolver<FacetWithLabel>
+  imageContentType: IResolver<FacetWithLabel>
 }
 
 // Record<CachedFacetType, IResolver<T>>
@@ -95,6 +105,14 @@ const getNewspaperResolver = (app: ImpressoApplication): IResolver<NewspaperInte
   }
 }
 
+const imageTypeResolver = async (id: string, field: keyof typeof ImageTypeValueLookup) => {
+  const lookup = ImageTypeValueLookup[field]
+  return {
+    id,
+    label: lookup[id] ?? id,
+  } satisfies FacetWithLabel
+}
+
 export const buildResolvers = (app: ImpressoApplication): ICachedResolvers => {
   return {
     collection: getCollectionResolver(app),
@@ -106,5 +124,9 @@ export const buildResolvers = (app: ImpressoApplication): ICachedResolvers => {
     partner: getPartnerResolver(app),
     nag: (id: string) => entityResolver(id, 'nag'),
     organisation: (id: string) => entityResolver(id, 'organisation'),
+    imageVisualContent: (id: string) => imageTypeResolver(id, 'type_l0_tp'),
+    imageTechnique: (id: string) => imageTypeResolver(id, 'type_l1_tp'),
+    imageCommunicationGoal: (id: string) => imageTypeResolver(id, 'type_l2_tp'),
+    imageContentType: (id: string) => imageTypeResolver(id, 'type_l3_tp'),
   }
 }

src/internalServices/cachedResolvers.ts

@@ -39,6 +39,10 @@ const FilterTypeToPythonArgumentName = {
   sourceMedium: '',
   organisation: '',
   embedding: 'embedding',
+  imageVisualContent: 'visual_content',
+  imageTechnique: 'technique',
+  imageCommunicationGoal: 'communication_goal',
+  imageContentType: 'content_type',
 } satisfies Record<FilterType, string>
 
 const BooleanTypes: FilterType[] = ['hasTextContents', 'isFront']

src/logic/filters/impressoPy.ts

@@ -1481,6 +1481,24 @@ export interface Image {
      */
     type?: "newspaper";
   };
+  imageTypes?: {
+    /**
+     * Whether the content is an image or not.
+     */
+    visualContent?: string;
+    /**
+     * Determines if the image is a photograph.
+     */
+    technique?: string;
+    /**
+     * Purpose or communicative function of the image.
+     */
+    communicationGoal?: string;
+    /**
+     * Classification of the visual content.
+     */
+    visualContentType?: string;
+  };
   /**
    * The date of the image or the date of the issue that the image belongs to.
    */
@@ -1846,7 +1864,7 @@ export interface SearchFacetBucket {
   /**
    * The item in the bucket. Particular objct schema depends on the facet type
    */
-  item?: Newspaper | Collection | Entity | Topic | Year | Partner;
+  item?: Newspaper | Collection | Entity | Topic | Year | Partner | FacetWithLabel;
 }
 /**
  * A newspaper
@@ -2164,6 +2182,19 @@ export interface Partner {
    */
   url?: string;
 }
+/**
+ * An facet that has a value and a label
+ */
+export interface FacetWithLabel {
+  /**
+   * Unique identifier of the facet
+   */
+  id: string;
+  /**
+   * Label of the facet
+   */
+  label: string;
+}
 /**
  * Facet bucket
  */
@@ -2206,7 +2237,7 @@ export interface SearchFacetBucket {
   /**
    * The item in the bucket. Particular objct schema depends on the facet type
    */
-  item?: Newspaper | Collection | Entity | Topic | Year | Partner;
+  item?: Newspaper | Collection | Entity | Topic | Year | Partner | FacetWithLabel;
 }
 /**
  * A newspaper
@@ -2524,6 +2555,19 @@ export interface Partner {
    */
   url?: string;
 }
+/**
+ * An facet that has a value and a label
+ */
+export interface FacetWithLabel {
+  /**
+   * Unique identifier of the facet
+   */
+  id: string;
+  /**
+   * Label of the facet
+   */
+  label: string;
+}
 
 
 /**

src/models/generated/schemas.d.ts

@@ -390,6 +390,25 @@ export interface EntityMention {
 }
 
 
+/**
+ * Information about an available experiment including its identifier, name, and description.
+ */
+export interface ExperimentInfo {
+  /**
+   * The unique identifier of the experiment.
+   */
+  id: string;
+  /**
+   * The display name of the experiment.
+   */
+  name: string;
+  /**
+   * A description of what the experiment does.
+   */
+  description?: string;
+}
+
+
 /**
  * Freeform schema - a schema that allows any property to be added to the object.
  */
@@ -426,6 +445,24 @@ export interface Image {
    * The page numbers of the issue that the image belongs to.
    */
   pageNumbers?: number[];
+  imageTypes?: {
+    /**
+     * Whether the content is an image or not.
+     */
+    visualContent?: string;
+    /**
+     * Determines if the image is a photograph.
+     */
+    technique?: string;
+    /**
+     * Purpose or communicative function of the image.
+     */
+    communicationGoal?: string;
+    /**
+     * Classification of the visual content.
+     */
+    visualContentType?: string;
+  };
   /**
    * The media source of the image
    */

src/models/generated/schemasPublic.d.ts

@@ -149,6 +149,21 @@ export interface Error {
 }
 
 
+/**
+ * An facet that has a value and a label
+ */
+export interface FacetWithLabel {
+  /**
+   * Unique identifier of the facet
+   */
+  id: string;
+  /**
+   * Label of the facet
+   */
+  label: string;
+}
+
+
 /**
  * A single filter criteria
  */

src/models/generated/shared.d.ts

@@ -52,6 +52,22 @@ export interface Image {
   iiif_url_s?: string;
   iiif_link_s?: string;
   cc_b?: boolean;
+  /**
+   * Whether the content is an image or not.
+   */
+  type_l0_tp?: string;
+  /**
+   * Determines if the image is a photograph.
+   */
+  type_l1_tp?: string;
+  /**
+   * Purpose or communicative function of the image.
+   */
+  type_l2_tp?: string;
+  /**
+   * Classification of the visual content.
+   */
+  type_l3_tp?: string;
   rights_data_domain_s?: string;
   rights_copyright_s?: string;
   rights_perm_use_explore_plain?: string[];

src/models/generated/solr.d.ts

@@ -11,21 +11,22 @@ import {
   Partner as IPartner,
 } from './generated/schemas'
 import { ImpressoApplication } from '../types'
+import { FacetWithLabel } from './generated/shared'
 
 type FacetType = 'newspaper' | 'language' | 'topic' | 'person' | 'location' | 'collection' | 'year'
 
 interface SearchFacetBucketOptions {
   val: string
   count: number
   uid?: string
-  item?: ITopic | IYear | IEntity | ICollection | INewspaper | IPartner
+  item?: ITopic | IYear | IEntity | ICollection | INewspaper | IPartner | FacetWithLabel
 }
 
 class SearchFacetBucket implements ISearchFacetBucket {
   public count: number
   public val: string
   public uid?: string
-  public item?: ITopic | IYear | IEntity | ICollection | INewspaper | IPartner
+  public item?: ITopic | IYear | IEntity | ICollection | INewspaper | IPartner | FacetWithLabel
   public lower?: number
   public upper?: number