Replace public properties by private+getters for BC promise

Author: chr-hertel

UPGRADE.md

@@ -79,6 +79,16 @@ Store
    +$indexer->index('/new/source');
    ```
 
+ * Properties of `Symfony\AI\Store\Document\VectorDocument` and `\Symfony\AI\Store\Document\Loader\Rss\RssItem` have been changed to private, use getters instead of public properties:
+
+   ```diff
+   -$document->id;
+   +$document->getId();
+
+   -$rssItem->title;
+   +$rssItem->getTitle();
+   ```
+
 UPGRADE FROM 0.2 to 0.3
 =======================
 

examples/document/vectorizing-text-documents.php

@@ -28,4 +28,4 @@
 $vectorizer = new Vectorizer($platform, 'text-embedding-3-large');
 $vectorDocuments = $vectorizer->vectorize($textDocuments);
 
-dump(array_map(static fn (VectorDocument $document) => $document->vector->getDimensions(), $vectorDocuments));
+dump(array_map(static fn (VectorDocument $document) => $document->getVector()->getDimensions(), $vectorDocuments));

examples/indexer/chunk-delay.php

@@ -79,5 +79,5 @@
 
 echo "Search results for 'machine learning artificial intelligence':\n";
 foreach ($results as $i => $document) {
-    echo sprintf("%d. %s\n", $i + 1, substr($document->id, 0, 40).'...');
+    echo sprintf("%d. %s\n", $i + 1, substr($document->getId(), 0, 40).'...');
 }

examples/indexer/index-documents.php

@@ -54,5 +54,5 @@
 $vector = $vectorizer->vectorize('machine learning artificial intelligence');
 $results = $store->query($vector);
 foreach ($results as $i => $document) {
-    echo sprintf("%d. %s\n", $i + 1, substr($document->id, 0, 40).'...');
+    echo sprintf("%d. %s\n", $i + 1, substr($document->getId(), 0, 40).'...');
 }

examples/indexer/index-file-loader.php

@@ -45,5 +45,5 @@
 $vector = $vectorizer->vectorize('Roman gladiator revenge');
 $results = $store->query($vector);
 foreach ($results as $i => $document) {
-    echo sprintf("%d. %s\n", $i + 1, substr($document->id, 0, 40).'...');
+    echo sprintf("%d. %s\n", $i + 1, substr($document->getId(), 0, 40).'...');
 }

examples/indexer/index-rss-loader.php

@@ -43,5 +43,5 @@
 $vector = $vectorizer->vectorize('Week of Symfony');
 $results = $store->query($vector);
 foreach ($results as $i => $document) {
-    echo sprintf("%d. %s\n", $i + 1, substr($document->id, 0, 40).'...');
+    echo sprintf("%d. %s\n", $i + 1, substr($document->getId(), 0, 40).'...');
 }

examples/indexer/index-with-filters.php

@@ -75,11 +75,11 @@
 
 $filteredDocuments = 0;
 foreach ($results as $i => $document) {
-    $title = $document->metadata['title'] ?? 'Unknown';
-    $category = $document->metadata['category'] ?? 'Unknown';
+    $title = $document->getMetadata()['title'] ?? 'Unknown';
+    $category = $document->getMetadata()['category'] ?? 'Unknown';
     echo sprintf("%d. %s [%s]\n", $i + 1, $title, $category);
-    echo sprintf("   Content: %s\n", substr($document->metadata->getText() ?? 'No content', 0, 80).'...');
-    echo sprintf("   ID: %s\n\n", substr($document->id, 0, 8).'...');
+    echo sprintf("   Content: %s\n", substr($document->getMetadata()->getText() ?? 'No content', 0, 80).'...');
+    echo sprintf("   ID: %s\n\n", substr($document->getId(), 0, 8).'...');
     ++$filteredDocuments;
 }
 

examples/ollama/indexer.php

@@ -45,5 +45,5 @@
 $vector = $vectorizer->vectorize('Roman gladiator revenge');
 $results = $store->query($vector);
 foreach ($results as $i => $document) {
-    echo sprintf("%d. %s\n", $i + 1, substr($document->id, 0, 40).'...');
+    echo sprintf("%d. %s\n", $i + 1, substr($document->getId(), 0, 40).'...');
 }

examples/retriever/basic.php

@@ -51,7 +51,7 @@
 $results = $retriever->retrieve('Roman gladiator revenge', ['maxItems' => 1]);
 
 foreach ($results as $i => $document) {
-    echo sprintf("%d. Document ID: %s\n", $i + 1, $document->id);
-    echo sprintf("   Score: %s\n", $document->score ?? 'n/a');
-    echo sprintf("   Source: %s\n\n", $document->metadata->getSource() ?? 'unknown');
+    echo sprintf("%d. Document ID: %s\n", $i + 1, $document->getId());
+    echo sprintf("   Score: %s\n", $document->getScore() ?? 'n/a');
+    echo sprintf("   Source: %s\n\n", $document->getMetadata()->getSource() ?? 'unknown');
 }

examples/retriever/movies.php

@@ -47,9 +47,9 @@
 $results = $retriever->retrieve('crime family mafia');
 
 foreach ($results as $i => $document) {
-    $title = $document->metadata['title'];
-    $director = $document->metadata['director'];
-    $score = $document->score;
+    $title = $document->getMetadata()['title'];
+    $director = $document->getMetadata()['director'];
+    $score = $document->getScore();
 
     echo sprintf("%d. %s (Director: %s)\n", $i + 1, $title, $director);
     echo sprintf("   Score: %.4f\n\n", $score ?? 0);