New search input (#2383)

## Summary
Fixes #{2289}

### Time to review: __5 mins__

## Changes proposed
> Added new request field to opportunity search route that allows users
to specify scoring rule.

 
## Context for reviewers
> Add two new static list of fields (scoring_rule) to query against when
calling OpenSearch with a query. User can specify which scoring
algorithm to use. If not provided, it will default to the "default"
scoring_rule.


## Additional information
> Screenshots, GIF demos, code examples or output to help show the
changes working as expected.

---------

Co-authored-by: nava-platform-bot <platform-admins@navapbc.com>

Author: babebe

api/openapi.generated.yml

@@ -1036,6 +1036,19 @@ components:
           - object
           allOf:
           - $ref: '#/components/schemas/CloseDateFilterV1'
+    ExperimentalV1:
+      type: object
+      properties:
+        scoring_rule:
+          default: !!python/object/apply:src.services.opportunities_v1.experimental_constant.ScoringRule
+          - default
+          description: Scoring rule to query against OpenSearch
+          enum:
+          - default
+          - expanded
+          - agency
+          type:
+          - string
     OpportunityPaginationV1:
       type: object
       properties:
@@ -1086,6 +1099,11 @@ components:
           - object
           allOf:
           - $ref: '#/components/schemas/OpportunitySearchFilterV1'
+        experimental:
+          type:
+          - object
+          allOf:
+          - $ref: '#/components/schemas/ExperimentalV1'
         pagination:
           type:
           - object

api/src/api/opportunities_v1/opportunity_schemas.py

@@ -16,6 +16,7 @@
     OpportunityStatus,
 )
 from src.pagination.pagination_schema import generate_pagination_schema
+from src.services.opportunities_v1.experimental_constant import ScoringRule
 
 
 class SearchResponseFormat(StrEnum):
@@ -423,6 +424,17 @@ class OpportunityFacetV1Schema(Schema):
     )
 
 
+class ExperimentalV1Schema(Schema):
+    scoring_rule = fields.Enum(
+        ScoringRule,
+        load_default=ScoringRule.DEFAULT,
+        metadata={
+            "description": "Scoring rule to query against OpenSearch",
+            "default": ScoringRule.DEFAULT,
+        },
+    )
+
+
 class OpportunitySearchRequestV1Schema(Schema):
     query = fields.String(
         metadata={
@@ -433,7 +445,7 @@ class OpportunitySearchRequestV1Schema(Schema):
     )
 
     filters = fields.Nested(OpportunitySearchFilterV1Schema())
-
+    experimental = fields.Nested(ExperimentalV1Schema())
     pagination = fields.Nested(
         generate_pagination_schema(
             "OpportunityPaginationV1Schema",

api/src/services/opportunities_v1/experimental_constant.py

@@ -0,0 +1,42 @@
+from enum import StrEnum
+
+DEFAULT = [
+    # Note that we do keyword for agency & opportunity number
+    # as we don't want to compare to a tokenized value which
+    # may have split on the dashes.
+    "agency.keyword^16",
+    "opportunity_title^2",
+    "opportunity_number.keyword^12",
+    "summary.summary_description",
+    "opportunity_assistance_listings.assistance_listing_number^10",
+    "opportunity_assistance_listings.program_title^4",
+]
+
+EXPANDED = [
+    "agency.keyword",
+    "agency_name",
+    "opportunity_title",
+    "opportunity_number.keyword",
+    "category_explanation",
+    "summary.summary_description",
+    "summary.applicant_eligibility_description",
+    "summary.funding_category_description",
+    "opportunity_assistance_listings.assistance_listing_number",
+    "opportunity_assistance_listings.program_title",
+]
+
+
+AGENCY = [
+    "agency.keyword",
+    "agency_name",
+    "summary.agency_contact_description",
+    "summary.agency_email_address.keyword",
+    "summary.agency_email_address_description",
+    "summary.agency_phone_number.keyword",
+]
+
+
+class ScoringRule(StrEnum):
+    DEFAULT = "default"
+    EXPANDED = "expanded"
+    AGENCY = "agency"

api/src/services/opportunities_v1/search_opportunities.py

@@ -14,6 +14,12 @@
     IntSearchFilter,
     StrSearchFilter,
 )
+from src.services.opportunities_v1.experimental_constant import (
+    AGENCY,
+    DEFAULT,
+    EXPANDED,
+    ScoringRule,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -41,17 +47,11 @@
     "estimated_total_program_funding": "summary.estimated_total_program_funding",
 }
 
-SEARCH_FIELDS = [
-    # Note that we do keyword for agency & opportunity number
-    # as we don't want to compare to a tokenized value which
-    # may have split on the dashes.
-    "agency.keyword^16",
-    "opportunity_title^2",
-    "opportunity_number.keyword^12",
-    "summary.summary_description",
-    "opportunity_assistance_listings.assistance_listing_number^10",
-    "opportunity_assistance_listings.program_title^4",
-]
+FILTER_RULE_MAPPING = {
+    ScoringRule.EXPANDED: EXPANDED,
+    ScoringRule.AGENCY: AGENCY,
+    ScoringRule.DEFAULT: DEFAULT,
+}
 
 SCHEMA = OpportunityV1Schema()
 
@@ -76,11 +76,16 @@ class OpportunityFilters(BaseModel):
     close_date: DateSearchFilter | None = None
 
 
+class Experimental(BaseModel):
+    scoring_rule: ScoringRule = Field(default=ScoringRule.DEFAULT)
+
+
 class SearchOpportunityParams(BaseModel):
     pagination: PaginationParams
 
     query: str | None = Field(default=None)
     filters: OpportunityFilters | None = Field(default=None)
+    experimental: Experimental = Field(default=Experimental())
 
 
 def _adjust_field_name(field: str) -> str:
@@ -148,7 +153,8 @@ def _get_search_request(params: SearchOpportunityParams) -> dict:
 
     # Query
     if params.query:
-        builder.simple_query(params.query, SEARCH_FIELDS)
+        filter_rule = FILTER_RULE_MAPPING.get(params.experimental.scoring_rule, DEFAULT)
+        builder.simple_query(params.query, filter_rule)
 
     # Filters
     _add_search_filters(builder, params.filters)

api/tests/src/api/opportunities_v1/conftest.py

@@ -32,6 +32,7 @@ def get_search_request(
     order_by: str = "opportunity_id",
     sort_direction: str = "ascending",
     query: str | None = None,
+    experimental: dict | None = None,
     funding_instrument_one_of: list[FundingInstrument] | None = None,
     funding_category_one_of: list[FundingCategory] | None = None,
     applicant_type_one_of: list[ApplicantType] | None = None,
@@ -106,6 +107,9 @@ def get_search_request(
     if format is not None:
         req["format"] = format
 
+    if experimental is not None:
+        req["experimental"] = experimental
+
     return req
 
 

api/tests/src/api/opportunities_v1/test_opportunity_route_search.py

@@ -1305,3 +1305,35 @@ def test_search_query_facets_200(self, client, api_auth_token):
             "funding_category",
             "opportunity_status",
         }
+
+    @pytest.mark.parametrize(
+        "search_request",
+        [
+            # default scoring rule
+            get_search_request(
+                query="literacy",
+            ),
+            # agency scoring rule
+            get_search_request(
+                query="literacy",
+                experimental={"scoring_rule": "agency"},
+            ),
+            # expanded scoring rule
+            get_search_request(
+                query="literacy",
+                experimental={"scoring_rule": "expanded"},
+            ),
+        ],
+    )
+    def test_search_experimental_200(self, client, api_auth_token, search_request):
+        # We are only testing for 200 responses when adding the experimental field into the request body.
+        resp = client.post(
+            "/v1/opportunities/search", json=search_request, headers={"X-Auth": api_auth_token}
+        )
+        assert resp.status_code == 200
+
+        search_request["format"] = "csv"
+        resp = client.post(
+            "/v1/opportunities/search", json=search_request, headers={"X-Auth": api_auth_token}
+        )
+        assert resp.status_code == 200