Skip to content

🌿 Fern Regeneration -- March 13, 2025 #38

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.

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
merged 1 commit into from
Mar 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "credal"

[tool.poetry]
name = "credal"
version = "0.0.23"
version = "0.0.24"
description = ""
readme = "README.md"
authors = []
Expand Down
143 changes: 0 additions & 143 deletions reference.md
Original file line number Diff line number Diff line change
@@ -1,147 +1,4 @@
# Reference
## Actions
<details><summary><code>client.actions.<a href="src/credal/actions/client.py">invoke_action</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Invoke an action, asking for human confirmation if necessary
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
import uuid

from credal import CredalApi
from credal.actions import HumanConfirmationChannel_SlackThread

client = CredalApi(
api_key="YOUR_API_KEY",
)
client.actions.invoke_action(
action_id=uuid.UUID(
"2b5cf2b8-3df3-11ef-9a96-332d4470d189",
),
action_inputs={
"textToAppend": "If you need more help, please contact your direct manager."
},
user_email="[email protected]",
require_human_confirmation=True,
human_confirmation_channel=HumanConfirmationChannel_SlackThread(
channel_id="ABC123",
thread_timestamp="123456789",
),
justification="The user directly asked to update the Relocations Confluence document with this text.",
audit_log_id=uuid.UUID(
"3df3f2b8-3df3-11ef-9a96-332d447011ef",
),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**action_id:** `uuid.UUID`

</dd>
</dl>

<dl>
<dd>

**user_email:** `str` — The user who we should take the action on behalf of


</dd>
</dl>

<dl>
<dd>

**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.


</dd>
</dl>

<dl>
<dd>

**justification:** `str` — The justification for requesting this action. This is likely generated by the LLM that requested the action.


</dd>
</dl>

<dl>
<dd>

**audit_log_id:** `uuid.UUID` — Audit log for the message that called for this action


</dd>
</dl>

<dl>
<dd>

**action_inputs:** `typing.Optional[typing.Any]` — The inputs needed to execute the action


</dd>
</dl>

<dl>
<dd>

**human_confirmation_channel:** `typing.Optional[HumanConfirmationChannel]` — Where we should ask for human confirmation if necessary


</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Copilots
<details><summary><code>client.copilots.<a href="src/credal/copilots/client.py">create_copilot</a>(...)</code></summary>
<dl>
Expand Down
23 changes: 1 addition & 22 deletions src/credal/__init__.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
# This file was auto-generated by Fern from our API Definition.

from . import actions, common, copilots, document_catalog, document_collections, permissions_service, search, users
from .actions import (
ActionStatus,
Conversation,
DirectMessage,
HumanConfirmationChannel,
HumanConfirmationChannel_Conversation,
HumanConfirmationChannel_DirectMessage,
HumanConfirmationChannel_SlackThread,
InvokeActionResponse,
SlackThread,
)
from . import common, copilots, document_catalog, document_collections, permissions_service, search, users
from .client import AsyncCredalApi, CredalApi
from .common import (
Collaborator,
Expand Down Expand Up @@ -108,7 +97,6 @@

__all__ = [
"Action",
"ActionStatus",
"AiEndpointConfiguration",
"AsyncCredalApi",
"AuthorizedResource",
Expand All @@ -120,7 +108,6 @@
"Collaborator",
"CollectionFilteredData",
"Configuration",
"Conversation",
"CreateCollectionResponse",
"CreateConversationResponse",
"CreateCopilotResponse",
Expand All @@ -131,7 +118,6 @@
"DatetimeFieldSchema",
"DeleteCollectionResponse",
"DeleteCopilotResponse",
"DirectMessage",
"DocumentCollectionSearchOptions",
"DocumentCollectionSearchResult",
"DocumentMetadataPatch",
Expand All @@ -146,14 +132,9 @@
"Filter_String",
"FinalChunk",
"Group",
"HumanConfirmationChannel",
"HumanConfirmationChannel_Conversation",
"HumanConfirmationChannel_DirectMessage",
"HumanConfirmationChannel_SlackThread",
"InitialChunk",
"InputVariable",
"InsertedAuditLog",
"InvokeActionResponse",
"MessageBlocked",
"MessageFeedback",
"MessageReply",
Expand Down Expand Up @@ -182,7 +163,6 @@
"SendMessageResponse_AiResponseResult",
"SendMessageResponse_BlockedResult",
"SingleFieldFilter",
"SlackThread",
"StreamingChunk",
"StreamingChunk_Blocked",
"StreamingChunk_DataChunk",
Expand All @@ -198,7 +178,6 @@
"UserMetadataPatch",
"WebSearchResult",
"__version__",
"actions",
"common",
"copilots",
"document_catalog",
Expand Down
25 changes: 0 additions & 25 deletions src/credal/actions/__init__.py

This file was deleted.

Loading
Loading