Skip to content

Commit df36e14

Browse files
SDK regeneration (#38)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 5e9c5be commit df36e14

14 files changed

+3
-637
lines changed

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "credal"
33

44
[tool.poetry]
55
name = "credal"
6-
version = "0.0.23"
6+
version = "0.0.24"
77
description = ""
88
readme = "README.md"
99
authors = []

reference.md

-143
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,4 @@
11
# Reference
2-
## Actions
3-
<details><summary><code>client.actions.<a href="src/credal/actions/client.py">invoke_action</a>(...)</code></summary>
4-
<dl>
5-
<dd>
6-
7-
#### 📝 Description
8-
9-
<dl>
10-
<dd>
11-
12-
<dl>
13-
<dd>
14-
15-
Invoke an action, asking for human confirmation if necessary
16-
</dd>
17-
</dl>
18-
</dd>
19-
</dl>
20-
21-
#### 🔌 Usage
22-
23-
<dl>
24-
<dd>
25-
26-
<dl>
27-
<dd>
28-
29-
```python
30-
import uuid
31-
32-
from credal import CredalApi
33-
from credal.actions import HumanConfirmationChannel_SlackThread
34-
35-
client = CredalApi(
36-
api_key="YOUR_API_KEY",
37-
)
38-
client.actions.invoke_action(
39-
action_id=uuid.UUID(
40-
"2b5cf2b8-3df3-11ef-9a96-332d4470d189",
41-
),
42-
action_inputs={
43-
"textToAppend": "If you need more help, please contact your direct manager."
44-
},
45-
user_email="[email protected]",
46-
require_human_confirmation=True,
47-
human_confirmation_channel=HumanConfirmationChannel_SlackThread(
48-
channel_id="ABC123",
49-
thread_timestamp="123456789",
50-
),
51-
justification="The user directly asked to update the Relocations Confluence document with this text.",
52-
audit_log_id=uuid.UUID(
53-
"3df3f2b8-3df3-11ef-9a96-332d447011ef",
54-
),
55-
)
56-
57-
```
58-
</dd>
59-
</dl>
60-
</dd>
61-
</dl>
62-
63-
#### ⚙️ Parameters
64-
65-
<dl>
66-
<dd>
67-
68-
<dl>
69-
<dd>
70-
71-
**action_id:** `uuid.UUID`
72-
73-
</dd>
74-
</dl>
75-
76-
<dl>
77-
<dd>
78-
79-
**user_email:** `str` — The user who we should take the action on behalf of
80-
81-
82-
</dd>
83-
</dl>
84-
85-
<dl>
86-
<dd>
87-
88-
**require_human_confirmation:** `bool` — If true, then before executing the action we will ask for a human confirmation in Slack. If false, we may still ask for human confirmation if it's required by your organization admin.
89-
90-
91-
</dd>
92-
</dl>
93-
94-
<dl>
95-
<dd>
96-
97-
**justification:** `str` — The justification for requesting this action. This is likely generated by the LLM that requested the action.
98-
99-
100-
</dd>
101-
</dl>
102-
103-
<dl>
104-
<dd>
105-
106-
**audit_log_id:** `uuid.UUID` — Audit log for the message that called for this action
107-
108-
109-
</dd>
110-
</dl>
111-
112-
<dl>
113-
<dd>
114-
115-
**action_inputs:** `typing.Optional[typing.Any]` — The inputs needed to execute the action
116-
117-
118-
</dd>
119-
</dl>
120-
121-
<dl>
122-
<dd>
123-
124-
**human_confirmation_channel:** `typing.Optional[HumanConfirmationChannel]` — Where we should ask for human confirmation if necessary
125-
126-
127-
</dd>
128-
</dl>
129-
130-
<dl>
131-
<dd>
132-
133-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
134-
135-
</dd>
136-
</dl>
137-
</dd>
138-
</dl>
139-
140-
141-
</dd>
142-
</dl>
143-
</details>
144-
1452
## Copilots
1463
<details><summary><code>client.copilots.<a href="src/credal/copilots/client.py">create_copilot</a>(...)</code></summary>
1474
<dl>

src/credal/__init__.py

+1-22
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
11
# This file was auto-generated by Fern from our API Definition.
22

3-
from . import actions, common, copilots, document_catalog, document_collections, permissions_service, search, users
4-
from .actions import (
5-
ActionStatus,
6-
Conversation,
7-
DirectMessage,
8-
HumanConfirmationChannel,
9-
HumanConfirmationChannel_Conversation,
10-
HumanConfirmationChannel_DirectMessage,
11-
HumanConfirmationChannel_SlackThread,
12-
InvokeActionResponse,
13-
SlackThread,
14-
)
3+
from . import common, copilots, document_catalog, document_collections, permissions_service, search, users
154
from .client import AsyncCredalApi, CredalApi
165
from .common import (
176
Collaborator,
@@ -108,7 +97,6 @@
10897

10998
__all__ = [
11099
"Action",
111-
"ActionStatus",
112100
"AiEndpointConfiguration",
113101
"AsyncCredalApi",
114102
"AuthorizedResource",
@@ -120,7 +108,6 @@
120108
"Collaborator",
121109
"CollectionFilteredData",
122110
"Configuration",
123-
"Conversation",
124111
"CreateCollectionResponse",
125112
"CreateConversationResponse",
126113
"CreateCopilotResponse",
@@ -131,7 +118,6 @@
131118
"DatetimeFieldSchema",
132119
"DeleteCollectionResponse",
133120
"DeleteCopilotResponse",
134-
"DirectMessage",
135121
"DocumentCollectionSearchOptions",
136122
"DocumentCollectionSearchResult",
137123
"DocumentMetadataPatch",
@@ -146,14 +132,9 @@
146132
"Filter_String",
147133
"FinalChunk",
148134
"Group",
149-
"HumanConfirmationChannel",
150-
"HumanConfirmationChannel_Conversation",
151-
"HumanConfirmationChannel_DirectMessage",
152-
"HumanConfirmationChannel_SlackThread",
153135
"InitialChunk",
154136
"InputVariable",
155137
"InsertedAuditLog",
156-
"InvokeActionResponse",
157138
"MessageBlocked",
158139
"MessageFeedback",
159140
"MessageReply",
@@ -182,7 +163,6 @@
182163
"SendMessageResponse_AiResponseResult",
183164
"SendMessageResponse_BlockedResult",
184165
"SingleFieldFilter",
185-
"SlackThread",
186166
"StreamingChunk",
187167
"StreamingChunk_Blocked",
188168
"StreamingChunk_DataChunk",
@@ -198,7 +178,6 @@
198178
"UserMetadataPatch",
199179
"WebSearchResult",
200180
"__version__",
201-
"actions",
202181
"common",
203182
"copilots",
204183
"document_catalog",

src/credal/actions/__init__.py

-25
This file was deleted.

0 commit comments

Comments
 (0)