Skip to content

Commit 13bd5bf

Browse files
committed
chore: update README usage section
1 parent d057c46 commit 13bd5bf

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ pip install pica-langchain
1212

1313
## Usage
1414

15-
PicaClientOptions
15+
### PicaClientOptions
16+
17+
The `PicaClientOptions` class allows you to configure the Pica client with the following options:
1618

1719
| Option | Type | Description |
1820
|--------|------|-------------|
19-
| server_url | str | Optional URL for self-hosted Pica server. Defaults to `https://api.picaos.com`. |
20-
| connectors | List[str] | Optional list of connector keys to give the LLM access to. If not provided, all available connectors will be initialized. |
21+
| `server_url` | `str` | Optional URL for self-hosted Pica server. Defaults to `https://api.picaos.com`. |
22+
| `connectors` | `List[str]` | Optional list of connector keys to give the LLM access to. If not provided, all available connectors will be initialized. |
2123

2224

2325
### Basic Usage
@@ -29,13 +31,7 @@ from pica_langchain import PicaClient, create_pica_agent
2931
from pica_langchain.models import PicaClientOptions
3032

3133
# Initialize the Pica client
32-
pica_client = PicaClient(
33-
secret="your-pica-secret",
34-
options=PicaClientOptions(
35-
# server_url="https://my-self-hosted-server.com",
36-
# connectors=["connector-key-1", "connector-key-2"]
37-
)
38-
)
34+
pica_client = PicaClient(secret="your-pica-secret")
3935

4036
# Create a LangChain agent with Pica tools
4137
llm = ChatOpenAI(
@@ -48,9 +44,7 @@ agent = create_pica_agent(
4844
client=pica_client,
4945
llm=llm,
5046
agent_type=AgentType.OPENAI_FUNCTIONS,
51-
52-
# Set to False to hide verbose agent logs
53-
verbose=True,
47+
verbose=True, # Set to False to hide verbose agent logs
5448

5549
# Optional: Custom system prompt to append
5650
system_prompt="Always start your response with `Pica works like ✨\n`"

0 commit comments

Comments
 (0)