invokeActionExample

Example0

This copilot is used to answer customer requests based on internal documentation.

Customer Copilot

Example Success

Example Blocked

Example1

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

addDocumentsToCollectionExample

This collection is used to answer customer requests based on internal documentation.

Customer Collection

removeDocumentsFromCollectionExample

searchDocumentCollectionExample

actions

copilots

documentCatalog

documentCollections

permissionsService

search

users

ActionStatus

Conversation

DirectMessage

HumanConfirmationChannel

InvokeActionResponse

SlackThread

Collaborator

ExternalResourceId

Operator

ResourceIdentifier

ResourceType

Role

AIEndpointConfiguration

BlockedChunk

BooleanFieldSchema

CollectionFilteredData

Configuration

CreateConversationResponse

CreateCopilotResponse

DataChunk

DataFilter

DatetimeFieldSchema

DeleteCopilotResponse

EndOfMessageChunk

FeedbackEnum

Filter

FinalChunk

InitialChunk

InputVariable

InsertedAuditLog

MessageBlocked

MessageFeedback

MessageReply

NumberFieldSchema

PolicyTrigger

ReferencedSource

ResponseChunk

SendAgentMessageResponse

SendMessageResponse

StreamingChunk

StringFieldSchema

WebSearchResult

DocumentMetadataPatch

DocumentMetadataPatchRequest

SyncSourceByUrlRequest

SyncSourceByUrlResponse

UploadDocumentResponse

CreateCollectionResponse

DeleteCollectionResponse

MongoCollectionSyncConfig

MongoCollectionSyncResponse

MongoSourceFieldsConfig

AuthorizedResource

AuthorizedResourceListPage

CheckBulkResourcesAuthorizationResponse

CheckResourceAuthorizationResponse

ResourceAuthorizationResult

DocumentCollectionSearchOptions

DocumentCollectionSearchResult

SearchDocumentCollectionResponse

SearchResultChunk

SingleFieldFilter

UserMetadataPatch

Credal | Documentation

1	from credal import CredalApi
2	from credal.users import UserMetadataPatch
3
4	client = CredalApi(
5	api_key="YOUR_API_KEY",
6	)
7	client.users.metadata(
8	request=[
9	UserMetadataPatch(
10	metadata={"State": "NY", "Job Role": "CEO"},
11	user_email="ravin@credal.ai",
12	),
13	UserMetadataPatch(
14	metadata={"State": "NY", "Department": "Engineering"},
15	user_email="jack@credal.ai",
16	),
17	],
18	)