add model descriptions
This commit is contained in:
@@ -34,7 +34,14 @@ class YargitayDetailedSearchRequest(BaseModel):
|
||||
to Yargitay's detailed search endpoint (e.g., /aramadetaylist).
|
||||
Based on the payload provided by the user.
|
||||
"""
|
||||
arananKelime: Optional[str] = Field("", description="Keyword to search for.")
|
||||
arananKelime: Optional[str] = Field("", description="""Keyword to search for with advanced operators support:
|
||||
• Simple words: 'arsa payı' (OR logic - finds documents with ANY word)
|
||||
• Exact phrases: '"arsa payı"' (finds exact phrase)
|
||||
• AND logic: 'arsa+payı' (both words required)
|
||||
• Wildcards: 'bozma*' (matches bozma, bozması, bozmanın, etc.)
|
||||
• Multiple required: '+"arsa payı" +"bozma sebebi"'
|
||||
• Exclusion: '+"arsa payı" -"inşaat sözleşmesi"'
|
||||
Examples: arsa payı | "arsa payı" | +"property right" +"cancellation reason" | legal*""")
|
||||
# Department/Board selection - Complete Yargıtay chamber hierarchy
|
||||
birimYrgKurulDaire: YargitayBirimEnum = Field("", description="""
|
||||
Yargıtay chamber/board selection. Options include:
|
||||
@@ -47,22 +54,53 @@ class YargitayDetailedSearchRequest(BaseModel):
|
||||
birimYrgHukukDaire: Optional[str] = Field("", description="Legacy field - use birimYrgKurulDaire instead")
|
||||
birimYrgCezaDaire: Optional[str] = Field("", description="Legacy field - use birimYrgKurulDaire instead")
|
||||
|
||||
esasYil: Optional[str] = Field("", description="Case year for 'Esas No'.")
|
||||
esasIlkSiraNo: Optional[str] = Field("", description="Starting sequence number for 'Esas No'.")
|
||||
esasSonSiraNo: Optional[str] = Field("", description="Ending sequence number for 'Esas No'.")
|
||||
esasYil: Optional[str] = Field("", description="""Case year for 'Esas No' filtering.
|
||||
Format: YYYY (e.g., '2024')
|
||||
Use with sequence numbers for precise case targeting""")
|
||||
esasIlkSiraNo: Optional[str] = Field("", description="""Starting sequence number for 'Esas No' range filtering.
|
||||
Format: numeric string (e.g., '1', '100')
|
||||
Use with esasSonSiraNo for range: cases 100-200 in specified year""")
|
||||
esasSonSiraNo: Optional[str] = Field("", description="""Ending sequence number for 'Esas No' range filtering.
|
||||
Format: numeric string (e.g., '500', '1000')
|
||||
Creates range from esasIlkSiraNo to this number""")
|
||||
|
||||
kararYil: Optional[str] = Field("", description="Decision year for 'Karar No'.")
|
||||
kararIlkSiraNo: Optional[str] = Field("", description="Starting sequence number for 'Karar No'.")
|
||||
kararSonSiraNo: Optional[str] = Field("", description="Ending sequence number for 'Karar No'.")
|
||||
kararYil: Optional[str] = Field("", description="""Decision year for 'Karar No' filtering.
|
||||
Format: YYYY (e.g., '2024')
|
||||
Filters decisions by the year they were issued""")
|
||||
kararIlkSiraNo: Optional[str] = Field("", description="""Starting sequence number for 'Karar No' range filtering.
|
||||
Format: numeric string (e.g., '1', '50')
|
||||
Use with kararSonSiraNo for decision number ranges""")
|
||||
kararSonSiraNo: Optional[str] = Field("", description="""Ending sequence number for 'Karar No' range filtering.
|
||||
Format: numeric string (e.g., '100', '500')
|
||||
Creates range from kararIlkSiraNo to this number""")
|
||||
|
||||
baslangicTarihi: Optional[str] = Field("", description="Start date for decision search (DD.MM.YYYY).")
|
||||
bitisTarihi: Optional[str] = Field("", description="End date for decision search (DD.MM.YYYY).")
|
||||
baslangicTarihi: Optional[str] = Field("", description="""Start date for decision search.
|
||||
Format: DD.MM.YYYY (e.g., '01.01.2024')
|
||||
Use with bitisTarihi for date range filtering
|
||||
Examples: '01.01.2024', '15.06.2023'""")
|
||||
bitisTarihi: Optional[str] = Field("", description="""End date for decision search.
|
||||
Format: DD.MM.YYYY (e.g., '31.12.2024')
|
||||
Creates date range from baslangicTarihi to this date
|
||||
Examples: '31.12.2024', '30.06.2023'""")""")
|
||||
|
||||
siralama: Optional[str] = Field("3", description="Sorting criteria (1: Esas No, 2: Karar No, 3: Karar Tarihi).") # Default to 'Karar Tarihine Göre'
|
||||
siralamaDirection: Optional[str] = Field("desc", description="Sorting direction ('asc' or 'desc').") # Default to 'Büyükten Küçüğe'
|
||||
siralama: Optional[str] = Field("3", description="""Sorting criteria for search results:
|
||||
• '1': Esas No (Case Number) - sorts by case registration order
|
||||
• '2': Karar No (Decision Number) - sorts by decision issuance order
|
||||
• '3': Karar Tarihi (Decision Date) - sorts by chronological order [DEFAULT]
|
||||
Recommended: Use '3' for most recent decisions first""")
|
||||
siralamaDirection: Optional[str] = Field("desc", description="""Sorting direction for results:
|
||||
• 'desc': Descending order (newest/highest first) [DEFAULT]
|
||||
• 'asc': Ascending order (oldest/lowest first)
|
||||
Most common: 'desc' for latest decisions first""")
|
||||
|
||||
pageSize: int = Field(10, ge=1, le=100, description="Number of results per page.")
|
||||
pageNumber: int = Field(1, ge=1, description="Page number to retrieve.")
|
||||
pageSize: int = Field(10, ge=1, le=100, description="""Number of results per page.
|
||||
Range: 1-100 results per page
|
||||
Recommended: 10-50 for balanced performance and coverage
|
||||
Large values (50-100) for comprehensive analysis""")
|
||||
pageNumber: int = Field(1, ge=1, description="""Page number to retrieve (1-indexed).
|
||||
Start with 1 for first page
|
||||
Use with pageSize to navigate through large result sets
|
||||
Example: pageSize=50, pageNumber=3 gets results 101-150""")
|
||||
|
||||
class YargitayApiDecisionEntry(BaseModel):
|
||||
"""Model for an individual decision entry from the Yargitay API search response."""
|
||||
|
||||
Reference in New Issue
Block a user