exa-py 1.7.0__tar.gz → 2.1.0__tar.gz

{exa_py-1.7.0 → exa_py-2.1.0}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: exa_py
-Version: 1.7.0
+Version: 2.1.0
 Summary: Python SDK for Exa API.
 Home-page: https://github.com/exa-labs/exa-py
 Author: Exa
 Author-email: hello@exa.ai
+License: UNKNOWN
+Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -15,16 +17,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
-Requires-Dist: requests
-Requires-Dist: typing-extensions
-Requires-Dist: openai>=1.10.0
 
 # Exa
 
-Exa (formerly Metaphor) API in Python
-
-Note: This API is basically the same as `metaphor-python` but reflects new
-features associated with Metaphor's rename to Exa. New site is https://exa.ai
+Exa API in Python
 
 ## Installation
 
@@ -43,17 +39,12 @@ exa = Exa(api_key="your-api-key")
 ```
 
 ## Common requests
+
 ```python
 
   # basic search
   results = exa.search("This is a Exa query:")
 
-  # autoprompted search
-  results = exa.search("autopromptable query", use_autoprompt=True)
-
-  # keyword search (non-neural)
-  results = exa.search("Google-style query", type="keyword")
-
   # search with date filters
   results = exa.search("This is a Exa query:", start_published_date="2019-01-01", end_published_date="2019-01-31")
 
@@ -63,14 +54,10 @@ exa = Exa(api_key="your-api-key")
   # search and get text contents
   results = exa.search_and_contents("This is a Exa query:")
 
-  # search and get highlights
-  results = exa.search_and_contents("This is a Exa query:", highlights=True)
-
   # search and get contents with contents options
-  results = exa.search_and_contents("This is a Exa query:", 
-                                    text={"include_html_tags": True, "max_characters": 1000}, 
-                                    highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
-                                    
+  results = exa.search_and_contents("This is a Exa query:",
+                                    text={"include_html_tags": True, "max_characters": 1000})
+
   # find similar documents
   results = exa.find_similar("https://example.com")
 
@@ -78,17 +65,62 @@ exa = Exa(api_key="your-api-key")
   results = exa.find_similar("https://example.com", exclude_source_domain=True)
 
   # find similar with contents
-  results = exa.find_similar_and_contents("https://example.com", text=True, highlights=True)
+  results = exa.find_similar_and_contents("https://example.com", text=True)
 
   # get text contents
-  results = exa.get_contents(["ids"])
-
-  # get highlights
-  results = exa.get_contents(["ids"], highlights=True)
+  results = exa.get_contents(["tesla.com"])
 
   # get contents with contents options
-  results = exa.get_contents(["ids"], 
-                             text={"include_html_tags": True, "max_characters": 1000}, 
-                             highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
+  results = exa.get_contents(["urls"],
+                             text={"include_html_tags": True, "max_characters": 1000})
+
+  # basic answer
+  response = exa.answer("This is a query to answer a question")
+
+  # answer with full text
+  response = exa.answer("This is a query to answer a question", text=True)
+
+  # answer with streaming
+  response = exa.stream_answer("This is a query to answer:")
+
+  # Print each chunk as it arrives when using the stream_answer method
+  for chunk in response:
+    print(chunk, end='', flush=True)
+
+  # research task example – answer a question with citations
+  # Example prompt & schema inspired by the TypeScript example.
+  QUESTION = (
+      "Summarize the history of San Francisco highlighting one or two major events "
+      "for each decade from 1850 to 1950"
+  )
+  OUTPUT_SCHEMA: Dict[str, Any] = {
+      "type": "object",
+      "required": ["timeline"],
+      "properties": {
+          "timeline": {
+              "type": "array",
+              "items": {
+                  "type": "object",
+                  "required": ["decade", "notableEvents"],
+                  "properties": {
+                      "decade": {
+                          "type": "string",
+                          "description": 'Decade label e.g. "1850s"',
+                      },
+                      "notableEvents": {
+                          "type": "string",
+                          "description": "A summary of notable events.",
+                      },
+                  },
+              },
+          },
+      },
+  }
+  resp = exa.research.create_task(
+      instructions=QUESTION,
+      model="exa-research",
+      output_schema=OUTPUT_SCHEMA,
+  )
 ```
 
+

exa_py-2.1.0/README.md

@@ -0,0 +1,104 @@
+# Exa
+
+Exa API in Python
+
+## Installation
+
+```bash
+pip install exa_py
+```
+
+## Usage
+
+Import the package and initialize the Exa client with your API key:
+
+```python
+from exa_py import Exa
+
+exa = Exa(api_key="your-api-key")
+```
+
+## Common requests
+
+```python
+
+  # basic search
+  results = exa.search("This is a Exa query:")
+
+  # search with date filters
+  results = exa.search("This is a Exa query:", start_published_date="2019-01-01", end_published_date="2019-01-31")
+
+  # search with domain filters
+  results = exa.search("This is a Exa query:", include_domains=["www.cnn.com", "www.nytimes.com"])
+
+  # search and get text contents
+  results = exa.search_and_contents("This is a Exa query:")
+
+  # search and get contents with contents options
+  results = exa.search_and_contents("This is a Exa query:",
+                                    text={"include_html_tags": True, "max_characters": 1000})
+
+  # find similar documents
+  results = exa.find_similar("https://example.com")
+
+  # find similar excluding source domain
+  results = exa.find_similar("https://example.com", exclude_source_domain=True)
+
+  # find similar with contents
+  results = exa.find_similar_and_contents("https://example.com", text=True)
+
+  # get text contents
+  results = exa.get_contents(["tesla.com"])
+
+  # get contents with contents options
+  results = exa.get_contents(["urls"],
+                             text={"include_html_tags": True, "max_characters": 1000})
+
+  # basic answer
+  response = exa.answer("This is a query to answer a question")
+
+  # answer with full text
+  response = exa.answer("This is a query to answer a question", text=True)
+
+  # answer with streaming
+  response = exa.stream_answer("This is a query to answer:")
+
+  # Print each chunk as it arrives when using the stream_answer method
+  for chunk in response:
+    print(chunk, end='', flush=True)
+
+  # research task example – answer a question with citations
+  # Example prompt & schema inspired by the TypeScript example.
+  QUESTION = (
+      "Summarize the history of San Francisco highlighting one or two major events "
+      "for each decade from 1850 to 1950"
+  )
+  OUTPUT_SCHEMA: Dict[str, Any] = {
+      "type": "object",
+      "required": ["timeline"],
+      "properties": {
+          "timeline": {
+              "type": "array",
+              "items": {
+                  "type": "object",
+                  "required": ["decade", "notableEvents"],
+                  "properties": {
+                      "decade": {
+                          "type": "string",
+                          "description": 'Decade label e.g. "1850s"',
+                      },
+                      "notableEvents": {
+                          "type": "string",
+                          "description": "A summary of notable events.",
+                      },
+                  },
+              },
+          },
+      },
+  }
+  resp = exa.research.create_task(
+      instructions=QUESTION,
+      model="exa-research",
+      output_schema=OUTPUT_SCHEMA,
+  )
+```

exa_py-2.1.0/exa_py/__init__.py

@@ -0,0 +1,2 @@
+from .api import Exa as Exa
+from .api import AsyncExa as AsyncExa