Skip to content

docs: fix factual errors in transport docs and CLI init page #646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chadbailey59 merged 1 commit into from
Mar 24, 2026
Merged

docs: fix factual errors in transport docs and CLI init page #646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions cli/init.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,6 @@ pipecat init [OPTIONS]
Enable transcription logging.
</ParamField>

<ParamField path="--smart-turn / --no-smart-turn" type="boolean">
Enable smart turn-taking. Defaults to `true` for cascade mode, `false` for
realtime.
</ParamField>

<ParamField
path="--video-input / --no-video-input"
type="boolean"
Expand Down Expand Up @@ -267,7 +262,6 @@ Sample `project-config.json`:
"tts_service": "cartesia_tts",
"recording": false,
"transcription": false,
"smart_turn": true,
"deploy_to_cloud": true,
"enable_krisp": false,
"enable_observability": false
Expand Down
6 changes: 3 additions & 3 deletions client/js/transports/gemini.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const options: GeminiLLMServiceOptions = {
},
{ role: "user", content: "Blub blub!" },
],
generation_config: {
settings: {
temperature: 0.7,
maxOutput_tokens: 1000,
},
Expand Down Expand Up @@ -66,7 +66,7 @@ interface GeminiLLMServiceOptions {
content: string;
role: string;
}>;
generation_config?: {
settings?: {
// Optional: Generation parameters
candidate_count?: number;
max_output_tokens?: number;
Expand Down Expand Up @@ -122,5 +122,5 @@ The GeminiLiveWebSocketTransport implements the various [PipecatClient event han
icon="browser"
href="https://www.npmjs.com/package/@pipecat-ai/gemini-live-websocket-transport"
>
`@pipecat-ai/realtime-websocket-transport`
`@pipecat-ai/gemini-live-websocket-transport`
</Card>
2 changes: 1 addition & 1 deletion client/js/transports/openai-webrtc.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import { PipecatClient } from '@pipecat-ai/client-js';

const options: OpenAIServiceOptions = {
api_key: 'YOUR_API_KEY',
session_config: {
settings: {
instructions: 'You are a confused jellyfish.',
},
initial_messages: [{ role: "user", content: "Blub blub!" }],
Expand Down
10 changes: 5 additions & 5 deletions client/js/transports/small-webrtc.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { SmallWebRTCTransport } from "@pipecat-ai/small-webrtc-transport";
const pcClient = new PipecatClient({
transport: new SmallWebRTCTransport({
// Optional configuration for the transport
iceServers: ["stun:stun.l.google.com:19302"],
iceServers: [{ urls: "stun:stun.l.google.com:19302" }],
}),
enableCam: false, // Default camera off
enableMic: true, // Default microphone on
Expand Down Expand Up @@ -49,14 +49,14 @@ interface SmallWebRTCTransportConstructorOptions {

#### Properties

<ParamField name="iceServers" type="string[]">
Array of STUN/TURN server URLs for ICE connection establishment. Default is `["stun:stun.l.google.com:19302"]`.
<ParamField name="iceServers" type="RTCIceServer[]">
Array of ICE server configurations for connection establishment. Default is `[{ urls: "stun:stun.l.google.com:19302" }]`.

```javascript
// Set custom ICE servers
transport.iceServers = [
"stun:stun.l.google.com:19302",
"stun:stun1.l.google.com:19302",
{ urls: "stun:stun.l.google.com:19302" },
{ urls: "stun:stun1.l.google.com:19302" },
];
```

Expand Down
Loading