Skip to content

Implement streamed responses for proposal/candidate similarity #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mzur merged 1 commit into from
Nov 21, 2025
Merged

Implement streamed responses for proposal/candidate similarity #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 36 additions & 23 deletions src/Http/Controllers/Api/AnnotationCandidateController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,34 +88,47 @@ public function indexSimilar($id, $id2)
$job = MaiaJob::findOrFail($id);
$this->authorize('access', $job);

$feature = AnnotationCandidateFeatureVector::where('job_id', $id)
->findOrFail($id2);

// Manually optimized query for the cosine distance. The nearestNeighbors()
// method of pgvector seems to compute the distances twice and returns lots
// of data that we don't need.
$ids = $feature->whereNotNull('vector')
->where('id', '!=', $feature->id)
->where('job_id', $id)
->orderByRaw('vector <=> ?', [$feature->vector])
->pluck('id');

$count = $ids->count();
if ($count === 0) {
$feature = AnnotationCandidateFeatureVector::findOrFail($id2);
$query = AnnotationCandidateFeatureVector::where('job_id', $id);
$hasFeatures = $query->clone()
->whereNotNull('vector')
->whereNot('id', $id2)
->exists();

if (!$hasFeatures) {
abort(Response::HTTP_NOT_FOUND);
}

if ($count !== ($job->annotationCandidates()->count() - 1)) {
$yieldItems = function () use ($query, $feature, $job): \Generator {
// Manually optimized query for the cosine distance. The nearestNeighbors()
// method of pgvector seems to compute the distances twice and returns lots
// of data that we don't need.
$idsQuery = $query->clone()
->whereNotNull('vector')
->whereNot('id', $feature->id)
->orderByRaw('vector <=> ?', [$feature->vector])
->orderBy('id')
->select('id');

foreach ($idsQuery->lazy() as $item) {
yield $item->id;
}

// Add IDs of candidates without feature vectors at the end.
$ids = $ids->concat(
$job->annotationCandidates()
->whereNotIn('id', $ids)
->whereNot('id', $id2)
->pluck('id')
);
}
$remainingIdsQuery = $job->annotationCandidates()
->whereNotIn('id', function ($query) use ($job) {
$query->select('id')
->from('maia_annotation_candidate_feature_vectors')
->where('job_id', $job->id);
});

foreach ($remainingIdsQuery->lazyById() as $item) {
yield $item->id;
}
};

return $ids;
// Use a streamed response because there can be a lot of items.
return response()->streamJson($yieldItems());
}

/**
Expand Down
61 changes: 37 additions & 24 deletions src/Http/Controllers/Api/TrainingProposalController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,34 +85,47 @@ public function indexSimilar($id, $id2)
$job = MaiaJob::findOrFail($id);
$this->authorize('access', $job);

$feature = TrainingProposalFeatureVector::where('job_id', $id)
->findOrFail($id2);

// Manually optimized query for the cosine distance. The nearestNeighbors()
// method of pgvector seems to compute the distances twice and returns lots
// of data that we don't need.
$ids = $feature->whereNotNull('vector')
->where('id', '!=', $feature->id)
->where('job_id', $id)
->orderByRaw('vector <=> ?', [$feature->vector])
->pluck('id');

$count = $ids->count();
if ($count === 0) {
$feature = TrainingProposalFeatureVector::findOrFail($id2);
$query = TrainingProposalFeatureVector::where('job_id', $id);
$hasFeatures = $query->clone()
->whereNotNull('vector')
->whereNot('id', $id2)
->exists();

if (!$hasFeatures) {
abort(Response::HTTP_NOT_FOUND);
}

if ($count !== ($job->trainingProposals()->count() - 1)) {
// Add IDs of proposals without feature vectors at the end.
$ids = $ids->concat(
$job->trainingProposals()
->whereNotIn('id', $ids)
->whereNot('id', $id2)
->pluck('id')
);
}
$yieldItems = function () use ($query, $feature, $job): \Generator {
// Manually optimized query for the cosine distance. The nearestNeighbors()
// method of pgvector seems to compute the distances twice and returns lots
// of data that we don't need.
$idsQuery = $query->clone()
->whereNotNull('vector')
->whereNot('id', $feature->id)
->orderByRaw('vector <=> ?', [$feature->vector])
->orderBy('id')
->select('id');

foreach ($idsQuery->lazy() as $item) {
yield $item->id;
}

// Add IDs of candidates without feature vectors at the end.
$remainingIdsQuery = $job->trainingProposals()
->whereNotIn('id', function ($query) use ($job) {
$query->select('id')
->from('maia_training_proposal_feature_vectors')
->where('job_id', $job->id);
});

foreach ($remainingIdsQuery->lazyById() as $item) {
yield $item->id;
}
};

return $ids;
// Use a streamed response because there can be a lot of items.
return response()->streamJson($yieldItems());
}

/**
Expand Down
34 changes: 28 additions & 6 deletions tests/Http/Controllers/Api/AnnotationCandidateControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,20 @@ public function testIndexSimilarity()
'vector' => range(0, 383),
]);

$this->getJson("/api/v1/maia-jobs/{$id}/annotation-candidates/similar-to/{$ac1->id}")
->assertStatus(200)
->assertExactJson([$ac3->id, $ac2->id]);
$response = $this->getJson("/api/v1/maia-jobs/{$id}/annotation-candidates/similar-to/{$ac1->id}")
->assertStatus(200);

ob_start();
$response->sendContent();
$content = ob_get_clean();
$response = new TestResponse(
new Response($content,
$response->baseResponse->getStatusCode(),
$response->baseResponse->headers->all()
)
);

$response->assertExactJson([$ac3->id, $ac2->id]);
}

public function testIndexSimilarityMissing()
Expand All @@ -250,9 +261,20 @@ public function testIndexSimilarityMissing()
$ac3 = AnnotationCandidateTest::create(['job_id' => $id]);

$this->beEditor();
$this->getJson("/api/v1/maia-jobs/{$id}/annotation-candidates/similar-to/{$ac1->id}")
->assertStatus(200)
->assertExactJson([$ac2->id, $ac3->id]);
$response = $this->getJson("/api/v1/maia-jobs/{$id}/annotation-candidates/similar-to/{$ac1->id}")
->assertStatus(200);

ob_start();
$response->sendContent();
$content = ob_get_clean();
$response = new TestResponse(
new Response($content,
$response->baseResponse->getStatusCode(),
$response->baseResponse->headers->all()
)
);

$response->assertExactJson([$ac2->id, $ac3->id]);
}

public function testIndexSimilarityEmpty()
Expand Down
34 changes: 28 additions & 6 deletions tests/Http/Controllers/Api/TrainingProposalControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,20 @@ public function testIndexSimilarity()
'vector' => range(0, 383),
]);

$this->getJson("/api/v1/maia-jobs/{$id}/training-proposals/similar-to/{$tp1->id}")
->assertStatus(200)
->assertExactJson([$tp3->id, $tp2->id]);
$response = $this->getJson("/api/v1/maia-jobs/{$id}/training-proposals/similar-to/{$tp1->id}")
->assertStatus(200);

ob_start();
$response->sendContent();
$content = ob_get_clean();
$response = new TestResponse(
new Response($content,
$response->baseResponse->getStatusCode(),
$response->baseResponse->headers->all()
)
);

$response->assertExactJson([$tp3->id, $tp2->id]);
}

public function testIndexSimilarityMissing()
Expand All @@ -232,9 +243,20 @@ public function testIndexSimilarityMissing()
$tp3 = TrainingProposalTest::create(['job_id' => $id]);

$this->beEditor();
$this->getJson("/api/v1/maia-jobs/{$id}/training-proposals/similar-to/{$tp1->id}")
->assertStatus(200)
->assertExactJson([$tp2->id, $tp3->id]);
$response = $this->getJson("/api/v1/maia-jobs/{$id}/training-proposals/similar-to/{$tp1->id}")
->assertStatus(200);

ob_start();
$response->sendContent();
$content = ob_get_clean();
$response = new TestResponse(
new Response($content,
$response->baseResponse->getStatusCode(),
$response->baseResponse->headers->all()
)
);

$response->assertExactJson([$tp2->id, $tp3->id]);
}

public function testIndexSimilarityEmpty()
Expand Down