updated

agent.py

@@ -56,6 +56,9 @@ class AgentTools:
         Args
             case_citation (str): the citation for a particular case. Citation must include the volume number, reporter, and first page. For example: 253 P.2d 136.
             summarize (bool): True to return just a summary of the case, False to return full case text.
+
+        returns
+            str: the full opinion/ruling text of the case, or the summary if summarize is True.
         """
         citation_dict = extract_components_from_citation(case_citation)
         if not citation_dict:
@@ -82,10 +85,16 @@ class AgentTools:
 
     def get_case_document_pdf(
             self,
-            case_citation = Field(description = citation_description)
+            case_citation: str = Field(description = citation_description)
             ) -> str:
         """
-        Given a case citation, returns a valid web url to a pdf of the case record
+        Given a case citation, returns a valid web URL to a pdf of the case record
+
+        Args:
+            case_citation (str): the citation for a particular case. Citation must include the volume number, reporter, and first page. For example: 253 P.2d 136.
+
+        Returns:
+            str: a valid web URL to a pdf of the case record
         """
         citation_dict = extract_components_from_citation(case_citation)
         if not citation_dict:
@@ -102,10 +111,16 @@ class AgentTools:
 
     def get_case_document_page(
             self,
-            case_citation = Field(description = citation_description)
+            case_citation: str = Field(description = citation_description)
             ) -> str:
         """
-        Given a case citation, returns a valid web url to a page with information about the case.
+        Given a case citation, returns a valid web URL to a page with information about the case.
+
+        Args:
+            case_citation (str): the citation for a particular case. Citation must include the volume number, reporter, and first page. For example: 253 P.2d 136.
+
+        Returns:
+            str: a valid web URL to a page with information about the case
         """
         citation_dict = extract_components_from_citation(case_citation)
         if not citation_dict:
@@ -121,10 +136,16 @@ class AgentTools:
         
     def get_case_name(
             self,
-            case_citation = Field(description = citation_description)
+            case_citation: str = Field(description = citation_description)
             ) -> Tuple[str, str]:
         """
         Given a case citation, returns its name and name abbreviation.
+
+        Args:
+            case_citation (str): the citation for a particular case. Citation must include the volume number, reporter, and first page. For example: 253 P.2d 136.
+
+        Returns:
+            Tuple[str, str]: the name and name abbreviation of the case
         """
         citation_dict = extract_components_from_citation(case_citation)
         if not citation_dict:
@@ -140,11 +161,16 @@ class AgentTools:
 
     def get_cited_cases(
             self,
-            case_citation = Field(description = citation_description)
+            case_citation: str = Field(description = citation_description)
             ) -> List[dict]:
         """
         Given a case citation, returns a list of cases that are cited by the opinion of this case.
-        The output is a list of cases, each a dict with the citation, name and name_abbreviation of the case.
+
+        Args:
+            case_citation (str): the citation for a particular case. Citation must include the volume number, reporter, and first page. For example: 253 P.2d 136.
+
+        Returns:
+            A list of cases, each a dict with the citation, name and name_abbreviation of the case.
         """
         citation_dict = extract_components_from_citation(case_citation)
         if not citation_dict:
@@ -169,15 +195,20 @@ class AgentTools:
 
     def validate_url(
             self,
-            url = Field(description = "A web url pointing to case-law document")
+            url: str = Field(description = "A web url pointing to case-law document")
         ) -> str:
         """
-        Given a link, returns whether or not the link is valid.
-        If it is not valid, it should not be used in any output.
+        Given a url, returns whether or not the url is valid.
+
+        Args:
+            url (str): A web url pointing to case-law document
+
+        Returns:
+            str: "URL is valid" if the url is valid, "URL is invalid" otherwise.
         """  
         pdf_pattern = re.compile(r'^https://static.case.law/.*')
         document_pattern = re.compile(r'^https://case.law/caselaw/?reporter=.*')
-        return "URL is valid" if bool(pdf_pattern.match(url)) | bool(document_pattern.match(url)) else "URL is bad"
+        return "URL is valid" if pdf_pattern.match(url) or document_pattern.match(url) else "URL is invalid"
 
     def get_tools(self):
         class QueryCaselawArgs(BaseModel):
@@ -238,34 +269,30 @@ def get_agent_config() -> OmegaConf:
 def initialize_agent(_cfg, agent_progress_callback=None):
     
     legal_assistant_instructions = """
-    - You are a helpful legal assistant, with expertise in case law for the state of Alaska.
-    - The ask_caselaw tool is your primary tool for answering user questions. Do not use your own knowledge to answer questions.
-    - If the ask_caselaw tool responds that it does not have enough information to answer the question,
-      try to rephrase the query or break it down into multiple sub-questions, and use the tool again.
-    - If the ask_caselaw tool returns a response along with a list of references mentioned in its response (in [N] format), 
-      Format your response to focus on the main response, and use the metadata (such as citations, decision date, or case name) 
-      in each relevant reference to provide more context in your response.
-    - If the ask_caselaw tool returns references with case citations, use the `get_case_document_pdf` tool to get a valid URL for the case.
-      and then use that link in your response to provide a clickable link to the case.
-    - Citations include 3 components: volume number, reporter, and first page. 
+    - You are a helpful legal assistant, with case law expertise in the state of Alaska.
+    - Use the 'ask_caselaw' tool as your primary tool for answering user questions. Do not use your own knowledge to answer questions.
+    - If the 'ask_caselaw' tool responds that it does not have enough information to answer the question,
+      try to rephrase the query, or break the original query down into multiple sub-questions, and use the 'ask_caselaw' tool again.
+    - The references returned by the 'ask_caselaw' tool include metadata relevant to its response, such as case citations, dates, or names.
+    - When using a case citation in your response, try to include a valid URL along with it:
+      * Call the 'get_case_document_pdf' for a case citation to obtain a valid web URL to a pdf of the case record.
+      * If this doesn't work, call the 'get_case_document_page' for a case citation to obtain a valid web URL to a page with information about the case.
+    - When including a URL for a citation in your response, use the citation as anchor text, and the URL as the link.
+    - Never use your internal knowledge to guess a case citation. Only use citation information provided by a tool or the user.
+    - A Case Citation includes 3 components: volume number, reporter, and first page. 
       Here are some examples: '253 P.2d 136', '10 Alaska 11', '6 C.M.A. 3'
-    - Never use your internal knowledge to guess citations. Only use citations information provided by a tool or the user.
-    - If you need a valid URL of the full case PDF, call the get_case_document_pdf tool.
-    - If you need a valid URL of the case information page, call the get_case_document_page tool.
-      The text displayed with this URL should be the name_abbreviation of the case (DON'T just say the info can be found here).
-      Don't call the get_case_document_page tool until after you have tried the get_case_document_pdf tool.
-      Don't provide URLs from any other tools. Do not generate URLs yourself.
     - If two cases have conflicting rulings, assume that the case with the more current ruling date is correct.
     - If the response is based on cases that are older than 5 years, make sure to inform the user that the information may be outdated,
       since some case opinions may no longer apply in law.
-    - To summarize the case, use the get_opinion_text with summarize=True.
-    - Use get_opinion_text with summarize=False only when full text is needed. Consider summarizing the text when possible to make things run faster.
-    - When presenting a URL in your response, use the 'validate_url' tool.
-    - If a user wants to test their argument, use the ask_caselaw tool to gather information about cases related to their argument 
-      and the critique_as_judge tool to determine whether their argument is sound or has issues that must be corrected.
+    - To summarize the case, use the 'get_opinion_text' with summarize=True.
+    - Use 'get_opinion_text' with summarize=False only when full text is needed. Consider summarizing the text when possible to make things run faster.
+    - If a user wants to test their argument, use the 'ask_caselaw' tool to gather information about cases related to their argument 
+      and the 'critique_as_judge' tool to determine whether their argument is sound or has issues that must be corrected.
     - Never discuss politics, and always respond politely.
+    - Your response should not include markdown.
     """
     agent_config = AgentConfig()
+
     agent = Agent(
         tools=AgentTools(_cfg, agent_config).get_tools(),
         topic="Case law in Alaska",
@@ -273,5 +300,5 @@ def initialize_agent(_cfg, agent_progress_callback=None):
         agent_progress_callback=agent_progress_callback,
         agent_config=agent_config
     )
-    agent.report()
+    agent.report(detailed=False)
     return agent