feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/perplexity-ai%2Fperplexity-aba0c21c569842e93e17b69cae9cee58d389fce9c2482f4d251fd8727db05679.yml
 openapi_spec_hash: 3d01b1c1425f7d43a8acf8b99bb9b321
-config_hash: 43831e7f153f67b8f23f7091d14db066
+config_hash: d7ba8374a217375f59388ce2ae8a5f90

README.md

@@ -50,12 +50,12 @@ const client = new Perplexity({
   apiKey: process.env['PERPLEXITY_API_KEY'], // This is the default and can be omitted
 });
 
-const completion = await client.chat.completions.create({
+const streamChunk = await client.chat.completions.create({
   messages: [{ role: 'user', content: 'Tell me about the latest developments in AI' }],
   model: 'sonar',
 });
 
-console.log(completion.choices[0].message.content);
+console.log(streamChunk.content);
 ```
 
 ### Advanced Search Features
@@ -139,6 +139,28 @@ const localSearch = await client.search.create({
 });
 ```
 
+## Streaming responses
+
+We provide support for streaming responses using Server Sent Events (SSE).
+
+```ts
+import Perplexity from '@perplexity-ai/perplexity_ai';
+
+const client = new Perplexity();
+
+const stream = await client.chat.completions.create({
+  messages: [{ role: 'user', content: 'What is the capital of France?' }],
+  model: 'sonar',
+  stream: true,
+});
+for await (const streamChunk of stream) {
+  console.log(streamChunk.id);
+}
+```
+
+If you need to cancel a stream, you can `break` from the loop
+or call `stream.controller.abort()`.
+
 ### Request & Response types
 
 This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
@@ -169,7 +191,7 @@ const chatParams: Perplexity.Chat.CompletionCreateParams = {
   messages: [{ role: 'user', content: 'What is the capital of France?' }],
   model: 'sonar',
 };
-const chatResponse: Perplexity.Chat.CompletionCreateResponse = await client.chat.completions.create(chatParams);
+const streamChunk: Perplexity.StreamChunk = await client.chat.completions.create(chatParams);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -195,7 +217,7 @@ const search = await client.search
   });
 
 // Chat completions error handling
-const completion = await client.chat.completions
+const streamChunk = await client.chat.completions
   .create({ messages: [{ role: 'user', content: 'What is the capital of France?' }], model: 'sonar' })
   .catch(async (err) => {
     if (err instanceof Perplexity.APIError) {
@@ -302,11 +324,11 @@ const chatResponse = await client.chat.completions
 console.log(chatResponse.headers.get('X-My-Header'));
 console.log(chatResponse.statusText); // access the underlying Response object
 
-const { data: completion, response: rawChatResponse } = await client.chat.completions
+const { data: streamChunk, response: rawChatResponse } = await client.chat.completions
   .create({ messages: [{ role: 'user', content: 'What is the capital of France?' }], model: 'sonar' })
   .withResponse();
 console.log(rawChatResponse.headers.get('X-My-Header'));
-console.log(completion.id);
+console.log(streamChunk.id);
 ```
 
 ### Logging

api.md

@@ -10,15 +10,15 @@ Types:
 
 # Chat
 
-## Completions
-
 Types:
 
-- <code><a href="./src/resources/chat/completions.ts">CompletionCreateResponse</a></code>
+- <code><a href="./src/resources/chat/chat.ts">StreamChunk</a></code>
+
+## Completions
 
 Methods:
 
-- <code title="post /chat/completions">client.chat.completions.<a href="./src/resources/chat/completions.ts">create</a>({ ...params }) -> CompletionCreateResponse</code>
+- <code title="post /chat/completions">client.chat.completions.<a href="./src/resources/chat/completions.ts">create</a>({ ...params }) -> StreamChunk</code>
 
 # Async
 

src/client.ts

@@ -18,7 +18,7 @@ import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import { Search, SearchCreateParams, SearchCreateResponse } from './resources/search';
 import { Async } from './resources/async/async';
-import { Chat } from './resources/chat/chat';
+import { Chat, StreamChunk } from './resources/chat/chat';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -728,7 +728,7 @@ Perplexity.Search = Search;
 export declare namespace Perplexity {
   export type RequestOptions = Opts.RequestOptions;
 
-  export { Chat as Chat };
+  export { Chat as Chat, type StreamChunk as StreamChunk };
 
   export { Async as Async };