@mesh-sync/worker-backend-client 4.0.3 → 4.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -12
- package/dist/client.d.ts +1 -1
- package/dist/client.js +1 -1
- package/dist/types.d.ts +3 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -924,7 +924,7 @@ and stores aggregated statistics in Elasticsearch for trend analysis.
|
|
|
924
924
|
|
|
925
925
|
### model-metadata-generation-request
|
|
926
926
|
|
|
927
|
-
**Description:** Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
927
|
+
**Description:** Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
928
928
|
|
|
929
929
|
**Method:** `client.modelMetadataGenerationRequest(data)`
|
|
930
930
|
|
|
@@ -932,17 +932,9 @@ and stores aggregated statistics in Elasticsearch for trend analysis.
|
|
|
932
932
|
|
|
933
933
|
**Fields:**
|
|
934
934
|
|
|
935
|
-
- `modelId` (string) [✗]: UUID of the model to generate metadata for. Worker queries database
|
|
935
|
+
- `modelId` (string) [✗]: UUID of the model to generate metadata for. Worker queries database to retrieve: 1) Model entity (name, fileName, fileSize, ownerId, storageItem relationship), 2) Model.technicalMetadata relationship (vertices, faces, quality scores, printability metrics), 3) AssociatedMedia.thumbnails (via associatedMediaId) for vision-enhanced analysis. All data fetched from PostgreSQL - no additional parameters required.
|
|
936
936
|
|
|
937
|
-
- `
|
|
938
|
-
|
|
939
|
-
- `parentJobId` (string) [✗]: ID of parent job (file-download, thumbnail-generation, or technical-analysis) for BullMQ dependency tracking. Ensures metadata generation runs after prerequisites complete. Should reference thumbnail-generation job when vision analysis is desired.
|
|
940
|
-
|
|
941
|
-
- `technicalMetadata` (object) [✗]: Technical analysis results (geometry, quality metrics, printability) passed from backend. Worker-core-lib Model schema lacks technical_metadata column, so backend must provide this data. Used for enhanced LLM prompt context. Include: vertexCount, faceCount, surfaceArea, volume, qualityScore, printabilityScore, detectedIssues, etc.
|
|
942
|
-
|
|
943
|
-
- `thumbnailPath` (string) [✗]: Path to generated thumbnail in MinIO storage (e.g., 'thumbnails/{modelId}/thumbnail.webp'). If provided, enables vision-enhanced metadata generation. Worker can also query thumbnail_media table, but explicit path improves performance.
|
|
944
|
-
|
|
945
|
-
- `enableVisionAnalysis` (boolean) [✗]: Flag to enable vision-based metadata enrichment using thumbnail images. Requires thumbnailPath or available thumbnail in database. Vision analysis generates more accurate descriptions, tags, and classifications based on visual appearance.
|
|
937
|
+
- `parentJobId` (string) [✗]: ID of parent thumbnail-generation job for BullMQ dependency tracking. SHOULD be set to thumbnail-generation job ID to ensure thumbnails are ready before metadata generation (required for default vision analysis). If omitted, worker will check for thumbnail existence and wait/retry if ENABLE_VISION_METADATA_GENERATION=true.
|
|
946
938
|
|
|
947
939
|
|
|
948
940
|
|
|
@@ -1591,7 +1583,7 @@ and stores aggregated statistics in Elasticsearch for trend analysis.
|
|
|
1591
1583
|
- Notifies backend that enriched marketplace metadata generation completed. Backend updates Model entity with generated description, tags, classification, etc.
|
|
1592
1584
|
|
|
1593
1585
|
- `modelMetadataGenerationRequest(data: ModelMetadataGenerationRequestMessage): Promise<JobResponse>`
|
|
1594
|
-
- Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
1586
|
+
- Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
1595
1587
|
|
|
1596
1588
|
- `modelMetamodelDetectionFound(data: ModelMetamodelDetectionFoundMessage): Promise<JobResponse>`
|
|
1597
1589
|
- Handles model metamodel detection found with hierarchical relationships.
|
package/dist/client.d.ts
CHANGED
|
@@ -236,7 +236,7 @@ export declare class WorkerClient {
|
|
|
236
236
|
*/
|
|
237
237
|
modelMetadataGenerationCompleted(data: types.ModelMetadataGenerationCompletedMessage): Promise<JobResponse>;
|
|
238
238
|
/**
|
|
239
|
-
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
239
|
+
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
240
240
|
* @param data - The message payload
|
|
241
241
|
* @returns Job response with job ID
|
|
242
242
|
*/
|
package/dist/client.js
CHANGED
|
@@ -313,7 +313,7 @@ export class WorkerClient {
|
|
|
313
313
|
return this.sendToQueue(types.MessageTypes.MODEL_METADATA_GENERATION_COMPLETED, data);
|
|
314
314
|
}
|
|
315
315
|
/**
|
|
316
|
-
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
316
|
+
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
317
317
|
* @param data - The message payload
|
|
318
318
|
* @returns Job response with job ID
|
|
319
319
|
*/
|
package/dist/types.d.ts
CHANGED
|
@@ -679,21 +679,13 @@ export interface ModelMetadataGenerationCompletedMessage {
|
|
|
679
679
|
metadata: Record<string, string | number | boolean>;
|
|
680
680
|
}
|
|
681
681
|
/**
|
|
682
|
-
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
682
|
+
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
683
683
|
*/
|
|
684
684
|
export interface ModelMetadataGenerationRequestMessage {
|
|
685
|
-
/** UUID of the model to generate metadata for. Worker queries database
|
|
685
|
+
/** UUID of the model to generate metadata for. Worker queries database to retrieve: 1) Model entity (name, fileName, fileSize, ownerId, storageItem relationship), 2) Model.technicalMetadata relationship (vertices, faces, quality scores, printability metrics), 3) AssociatedMedia.thumbnails (via associatedMediaId) for vision-enhanced analysis. All data fetched from PostgreSQL - no additional parameters required. */
|
|
686
686
|
modelId?: string;
|
|
687
|
-
/**
|
|
688
|
-
ownerId?: string;
|
|
689
|
-
/** ID of parent job (file-download, thumbnail-generation, or technical-analysis) for BullMQ dependency tracking. Ensures metadata generation runs after prerequisites complete. Should reference thumbnail-generation job when vision analysis is desired. */
|
|
687
|
+
/** ID of parent thumbnail-generation job for BullMQ dependency tracking. SHOULD be set to thumbnail-generation job ID to ensure thumbnails are ready before metadata generation (required for default vision analysis). If omitted, worker will check for thumbnail existence and wait/retry if ENABLE_VISION_METADATA_GENERATION=true. */
|
|
690
688
|
parentJobId?: string;
|
|
691
|
-
/** Technical analysis results (geometry, quality metrics, printability) passed from backend. Worker-core-lib Model schema lacks technical_metadata column, so backend must provide this data. Used for enhanced LLM prompt context. Include: vertexCount, faceCount, surfaceArea, volume, qualityScore, printabilityScore, detectedIssues, etc. */
|
|
692
|
-
technicalMetadata?: Record<string, string | number | boolean>;
|
|
693
|
-
/** Path to generated thumbnail in MinIO storage (e.g., 'thumbnails/{modelId}/thumbnail.webp'). If provided, enables vision-enhanced metadata generation. Worker can also query thumbnail_media table, but explicit path improves performance. */
|
|
694
|
-
thumbnailPath?: string;
|
|
695
|
-
/** Flag to enable vision-based metadata enrichment using thumbnail images. Requires thumbnailPath or available thumbnail in database. Vision analysis generates more accurate descriptions, tags, and classifications based on visual appearance. */
|
|
696
|
-
enableVisionAnalysis?: boolean;
|
|
697
689
|
}
|
|
698
690
|
/**
|
|
699
691
|
* Handles model metamodel detection found with hierarchical relationships.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mesh-sync/worker-backend-client",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.5",
|
|
4
4
|
"description": "Auto-generated TypeScript client for worker-backend - provides type-safe methods for enqueueing jobs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|