perplexityai 0.5.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

{perplexityai-0.5.0.dist-info → perplexityai-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: perplexityai
-Version: 0.5.0
+Version: 0.7.0
 Summary: The official Python library for the perplexity API
 Project-URL: Homepage, https://github.com/ppl-ai/perplexity-py
 Project-URL: Repository, https://github.com/ppl-ai/perplexity-py
@@ -67,10 +67,16 @@ client = Perplexity(
     api_key=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
-search = client.search.create(
-    query="string",
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "Tell me about the latest developments in AI",
+        }
+    ],
+    model="sonar",
 )
-print(search.id)
+print(completion.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -93,10 +99,16 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    search = await client.search.create(
-        query="string",
+    completion = await client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": "Tell me about the latest developments in AI",
+            }
+        ],
+        model="sonar",
     )
-    print(search.id)
+    print(completion.id)
 
 
 asyncio.run(main())
@@ -128,10 +140,16 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        search = await client.search.create(
-            query="string",
+        completion = await client.chat.completions.create(
+            messages=[
+                {
+                    "role": "user",
+                    "content": "Tell me about the latest developments in AI",
+                }
+            ],
+            model="sonar",
         )
-        print(search.id)
+        print(completion.id)
 
 
 asyncio.run(main())
@@ -146,6 +164,28 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from perplexity import Perplexity
+
+client = Perplexity()
+
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="sonar",
+    web_search_options={},
+)
+print(completion.web_search_options)
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `perplexity.APIConnectionError` is raised.
@@ -162,8 +202,14 @@ from perplexity import Perplexity
 client = Perplexity()
 
 try:
-    client.search.create(
-        query="string",
+    client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": "What is the capital of France?",
+            }
+        ],
+        model="sonar",
     )
 except perplexity.APIConnectionError as e:
     print("The server could not be reached")
@@ -207,8 +253,14 @@ client = Perplexity(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).search.create(
-    query="string",
+client.with_options(max_retries=5).chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 )
 ```
 
@@ -232,8 +284,14 @@ client = Perplexity(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).search.create(
-    query="string",
+client.with_options(timeout=5.0).chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 )
 ```
 
@@ -275,13 +333,17 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from perplexity import Perplexity
 
 client = Perplexity()
-response = client.search.with_raw_response.create(
-    query="string",
+response = client.chat.completions.with_raw_response.create(
+    messages=[{
+        "role": "user",
+        "content": "What is the capital of France?",
+    }],
+    model="sonar",
 )
 print(response.headers.get('X-My-Header'))
 
-search = response.parse()  # get the object that `search.create()` would have returned
-print(search.id)
+completion = response.parse()  # get the object that `chat.completions.create()` would have returned
+print(completion.id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/ppl-ai/perplexity-py/tree/main/src/perplexity/_response.py) object.
@@ -295,8 +357,14 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.search.with_streaming_response.create(
-    query="string",
+with client.chat.completions.with_streaming_response.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

perplexityai-0.7.0.dist-info/RECORD

@@ -0,0 +1,65 @@
+perplexity/__init__.py,sha256=5epbvK3UiJEgvsBW9Ds6RFB6zObkUxYkA9fIQlgUaXA,2655
+perplexity/_base_client.py,sha256=DSeMteXutziRGJA9HqJaoLpG7ktzpU2GPcaIgQT1oZQ,67051
+perplexity/_client.py,sha256=Uy5nrz9S9FTCy3-s1EGLOr-b8LJ2M2GTuQAB1GclZHE,16611
+perplexity/_compat.py,sha256=DQBVORjFb33zch24jzkhM14msvnzY7mmSmgDLaVFUM8,6562
+perplexity/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
+perplexity/_exceptions.py,sha256=v-hOXWSDTEtXcn_By7pPml3HjEmG5HXpbE-RK_A6_0Q,3228
+perplexity/_files.py,sha256=KnEzGi_O756MvKyJ4fOCW_u3JhOeWPQ4RsmDvqihDQU,3545
+perplexity/_models.py,sha256=c29x_mRccdxlGwdUPfSR5eJxGXe74Ea5Dje5igZTrKQ,30024
+perplexity/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
+perplexity/_resource.py,sha256=Pgc8KNBsIc1ltJn94uhDcDl0-3n5RLbe3iC2AiiNRnE,1124
+perplexity/_response.py,sha256=bpqzmVGq6jnivoMkUgt3OI0Rh6xHd6BMcp5PHgSFPb0,28842
+perplexity/_streaming.py,sha256=SQ61v42gFmNiO57uMFUZMAuDlGE0n_EulkZcPgJXt4U,10116
+perplexity/_types.py,sha256=XZYv2_G7oQGhQkjI28-TFIMP_yZZV590TRuKAoLJ3wM,7300
+perplexity/_version.py,sha256=uCysX84wOk6jVxbeJH9qOeK6dKiSul86f3NkeqwTEBk,162
+perplexity/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+perplexity/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
+perplexity/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
+perplexity/_utils/_datetime_parse.py,sha256=bABTs0Bc6rabdFvnIwXjEhWL15TcRgWZ_6XGTqN8xUk,4204
+perplexity/_utils/_logs.py,sha256=CsE-zYnAQTOCueNGVjEn6bozMyE86gdjMhJDNWDLpaQ,786
+perplexity/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
+perplexity/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
+perplexity/_utils/_resources_proxy.py,sha256=iMCHPeYmXwSunawEq3fcKGszOF3kL9w1ob-48Xnl04I,609
+perplexity/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
+perplexity/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
+perplexity/_utils/_transform.py,sha256=i_U4R82RtQJtKKCriwFqmfcWjtwmmsiiF1AEXKQ_OPo,15957
+perplexity/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,4786
+perplexity/_utils/_utils.py,sha256=D2QE7mVPNEJzaB50u8rvDQAUDS5jx7JoeFD7zdj-TeI,12231
+perplexity/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
+perplexity/resources/__init__.py,sha256=gQcgmiNY3uzaN5eAh9eclKJZRSaklhYcCF4ZTnFqemc,1877
+perplexity/resources/content.py,sha256=6nv6_mtcvEnREDHbtia8EGghlttquY77fzw-akZB28U,6073
+perplexity/resources/search.py,sha256=V67w1ql-6qsHjxj5WZ6CBHb0-NvMDi7U8Wg_flqfk74,12140
+perplexity/resources/async_/__init__.py,sha256=hvcoEKx4nCYPDoBSO_sk-uNVQ7y-fmNhzvAlvX19TIo,964
+perplexity/resources/async_/async_.py,sha256=p1-C_8m2cdS0NR3oa7FfdM8gxHH13LQWX6c9lh1gnFo,3510
+perplexity/resources/async_/chat/__init__.py,sha256=BVAfz9TM3DT5W9f_mt0P9YRxL_MsUxKCWAH6u1iogmA,1041
+perplexity/resources/async_/chat/chat.py,sha256=wOHHfLclvjAVv-btASi6EcdY5gJZQdwAdbR9Q9H4BKw,3658
+perplexity/resources/async_/chat/completions.py,sha256=aQEd_z5FRl3N5YIqj3hC2LFFDLK70aVu9AubzodNNNk,13324
+perplexity/resources/chat/__init__.py,sha256=BVAfz9TM3DT5W9f_mt0P9YRxL_MsUxKCWAH6u1iogmA,1041
+perplexity/resources/chat/chat.py,sha256=P143HQo1m9MknnYtSq4JzmDofDtGHlXHzTaLEyr1a7k,3656
+perplexity/resources/chat/completions.py,sha256=H0UwLYxERV2LXNj9ZBZlqLNPcB1U3dv9rqsq3BHKgn8,13315
+perplexity/types/__init__.py,sha256=ho1vOafTpRoPrIpgk1taoebxSZ9QbkyBPWJCMHlbyKU,589
+perplexity/types/content_create_params.py,sha256=qP3YBo-7wzh_1SNakoBO9ssUE8VmkLmin5pY6ebfdME,386
+perplexity/types/content_create_response.py,sha256=_iwdGBc28BC4aYNIQ4p-yrc7ltVsUUbK7cb8J-5Ayk0,735
+perplexity/types/search_create_params.py,sha256=zpsqdiQ78bDjPUE-dCIWZHQf5U_HyUrI55MnUHlW_Rg,2042
+perplexity/types/search_create_response.py,sha256=SSOaX0FBdDeYL2dVlzYJraYKedjoPObzrG_RPw1SmDw,803
+perplexity/types/async_/__init__.py,sha256=OKfJYcKb4NObdiRObqJV_dOyDQ8feXekDUge2o_4pXQ,122
+perplexity/types/async_/chat/__init__.py,sha256=1ULArAJormThTsN1-TBsDQ-gKB6HIIJNtVaoR8PPJRg,555
+perplexity/types/async_/chat/completion_create_params.py,sha256=CO76R15VQ_Bnt6pQ-huUXPJdeDFK2OzoXo5uSjHtIec,3048
+perplexity/types/async_/chat/completion_create_response.py,sha256=fdwHTGwQi01ysHJMX-nEQ5JJUDy0naZhSJ30Rhb5nNU,1259
+perplexity/types/async_/chat/completion_get_response.py,sha256=6vOpEH8X-V2kLnN3GSzYa6VadZ4J-e9YHX6ApJvdpzw,1253
+perplexity/types/async_/chat/completion_list_params.py,sha256=rRPgrSIOl5PZ8HeDAOPbKTQ8_u0sGubtYnYdsomuy7Y,390
+perplexity/types/async_/chat/completion_list_response.py,sha256=tI_XxSUmo7JnBwtpBl7Vb8R1rsOTHlYnScG5_LL8k0s,645
+perplexity/types/chat/__init__.py,sha256=A5VCUPqJZydjjOqEXC01GXmcDkKM3bq6zuCu9lmi5Es,303
+perplexity/types/chat/completion_create_params.py,sha256=GEF0xGk3krsQbUaFMJYKcph573Py571Rm2q8Qwiesww,2921
+perplexity/types/chat/completion_create_response.py,sha256=5UjMQEQC8wUcM7H9FllzLpwoSM9x9gSd0dtXFXVrqcU,718
+perplexity/types/shared/__init__.py,sha256=I_5WnFCvU4sKlUMTpqkuQCmyUpU4MHrslicgzGNop80,293
+perplexity/types/shared/chat_choice.py,sha256=gez_WTykZW7I54rGr0WJAvdPVExdvc1BgR4E8e57dsY,386
+perplexity/types/shared/chat_message.py,sha256=_KkDHtLJylc9NuJHQEjdBpMy2qEIxV2lz1Uana8hzNk,847
+perplexity/types/shared/search_result.py,sha256=pm4L1gWI9_8NtpI1kjdfXzoOpD0CDE4IhrG6yED98go,271
+perplexity/types/shared/usage_info.py,sha256=TGAReiJmZBjfXVxGsrKNaT7E0f5pi_D3GqB2qqjXOCc,458
+perplexity/types/shared_params/__init__.py,sha256=vOrN5p21OFWPGWV_y68OkZnQltAXa53y308Tg2Lmct4,140
+perplexity/types/shared_params/chat_message.py,sha256=haPdpCCjcOfLzcP25VeiVsSBuipz43co8HF_oFfWCf8,943
+perplexityai-0.7.0.dist-info/METADATA,sha256=LBcuSfZ1GtdG5krefpUPQ7Gy2xkxXNRrJOfOgUCB1MI,15261
+perplexityai-0.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+perplexityai-0.7.0.dist-info/licenses/LICENSE,sha256=hkCriG3MT4vBhhc0roAOsrCE7IEDr1ywVEMonVHGmAQ,11340
+perplexityai-0.7.0.dist-info/RECORD,,

perplexityai-0.5.0.dist-info/RECORD

@@ -1,37 +0,0 @@
-perplexity/__init__.py,sha256=5epbvK3UiJEgvsBW9Ds6RFB6zObkUxYkA9fIQlgUaXA,2655
-perplexity/_base_client.py,sha256=DSeMteXutziRGJA9HqJaoLpG7ktzpU2GPcaIgQT1oZQ,67051
-perplexity/_client.py,sha256=9vsUrMdMmEO8Hz7yAEQJbTd3jszVlJERm0TMLyCQuBY,15080
-perplexity/_compat.py,sha256=DQBVORjFb33zch24jzkhM14msvnzY7mmSmgDLaVFUM8,6562
-perplexity/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
-perplexity/_exceptions.py,sha256=v-hOXWSDTEtXcn_By7pPml3HjEmG5HXpbE-RK_A6_0Q,3228
-perplexity/_files.py,sha256=KnEzGi_O756MvKyJ4fOCW_u3JhOeWPQ4RsmDvqihDQU,3545
-perplexity/_models.py,sha256=c29x_mRccdxlGwdUPfSR5eJxGXe74Ea5Dje5igZTrKQ,30024
-perplexity/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
-perplexity/_resource.py,sha256=Pgc8KNBsIc1ltJn94uhDcDl0-3n5RLbe3iC2AiiNRnE,1124
-perplexity/_response.py,sha256=bpqzmVGq6jnivoMkUgt3OI0Rh6xHd6BMcp5PHgSFPb0,28842
-perplexity/_streaming.py,sha256=SQ61v42gFmNiO57uMFUZMAuDlGE0n_EulkZcPgJXt4U,10116
-perplexity/_types.py,sha256=XZYv2_G7oQGhQkjI28-TFIMP_yZZV590TRuKAoLJ3wM,7300
-perplexity/_version.py,sha256=r7xvBu1r6SCzn2w8FnNCT0y6vSjIPhARbGd3iWRTuDU,162
-perplexity/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-perplexity/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
-perplexity/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
-perplexity/_utils/_datetime_parse.py,sha256=bABTs0Bc6rabdFvnIwXjEhWL15TcRgWZ_6XGTqN8xUk,4204
-perplexity/_utils/_logs.py,sha256=CsE-zYnAQTOCueNGVjEn6bozMyE86gdjMhJDNWDLpaQ,786
-perplexity/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
-perplexity/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
-perplexity/_utils/_resources_proxy.py,sha256=iMCHPeYmXwSunawEq3fcKGszOF3kL9w1ob-48Xnl04I,609
-perplexity/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
-perplexity/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
-perplexity/_utils/_transform.py,sha256=i_U4R82RtQJtKKCriwFqmfcWjtwmmsiiF1AEXKQ_OPo,15957
-perplexity/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,4786
-perplexity/_utils/_utils.py,sha256=D2QE7mVPNEJzaB50u8rvDQAUDS5jx7JoeFD7zdj-TeI,12231
-perplexity/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
-perplexity/resources/__init__.py,sha256=e0o4Fhm2rFANVaRFoUJUmfCjJunhyhiJHWWRRnwv_yg,552
-perplexity/resources/search.py,sha256=8wlC-XJbprA1q6Ba_MZQ4aABUKvPnpBuFoY__YWaZOY,9028
-perplexity/types/__init__.py,sha256=yc0WYtyPE_vei_eT8gwY9-g7otC7EJjQpKSdeBcte4Y,279
-perplexity/types/search_create_params.py,sha256=RR5716GptBeuX99P0VHICzd5fEYsiwKdz1bW8nAlujI,886
-perplexity/types/search_create_response.py,sha256=lOteaJs4qpULkx5GLtEs6HhetqIBhM0I1AC1moWTeI8,426
-perplexityai-0.5.0.dist-info/METADATA,sha256=WoYAXSvZB8oFZKmFekj5FLK8z4vzq7mv9CXNEY4ijto,13621
-perplexityai-0.5.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-perplexityai-0.5.0.dist-info/licenses/LICENSE,sha256=hkCriG3MT4vBhhc0roAOsrCE7IEDr1ywVEMonVHGmAQ,11340
-perplexityai-0.5.0.dist-info/RECORD,,