1212<dl >
1313<dd >
1414
15- Create a new copilot . The API key used will be added to the copilot for future Requests
15+ Create a new agent . The API key used will be added to the agent for future Requests
1616</dd >
1717</dl >
1818</dd >
@@ -34,8 +34,8 @@ client = CredalApi(
3434 api_key = " YOUR_API_KEY" ,
3535)
3636client.copilots.create_copilot(
37- name = " Customer Copilot " ,
38- description = " This copilot is used to answer customer requests based on internal documentation." ,
37+ name = " Customer Agent " ,
38+ description = " This agent is used to answer customer requests based on internal documentation." ,
3939 collaborators = [
4040 Collaborator(
4141@@ -58,23 +58,23 @@ client.copilots.create_copilot(
5858<dl >
5959<dd >
6060
61- ** name:** ` str ` — A descriptive name for the copilot .
61+ ** name:** ` str ` — A descriptive name for the agent .
6262
6363</dd >
6464</dl >
6565
6666<dl >
6767<dd >
6868
69- ** description:** ` str ` — An in depth name for the copilot 's function. Useful for routing requests to the right copilot .
69+ ** description:** ` str ` — An in depth name for the agent 's function. Useful for routing requests to the right agent .
7070
7171</dd >
7272</dl >
7373
7474<dl >
7575<dd >
7676
77- ** collaborators:** ` typing.Sequence[Collaborator] ` — A list of collaborator emails and roles that will have access to the copilot .
77+ ** collaborators:** ` typing.Sequence[Collaborator] ` — A list of collaborator emails and roles that will have access to the agent .
7878
7979</dd >
8080</dl >
@@ -106,7 +106,7 @@ client.copilots.create_copilot(
106106<dl >
107107<dd >
108108
109- OPTIONAL. Create a new conversation with the Copilot . The conversation ID can be used in the ` sendMessage ` endpoint. The ` sendMessage ` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
109+ OPTIONAL. Create a new conversation with the Agent . The conversation ID can be used in the ` sendMessage ` endpoint. The ` sendMessage ` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
110110</dd >
111111</dl >
112112</dd >
@@ -149,7 +149,7 @@ client.copilots.create_conversation(
149149<dl >
150150<dd >
151151
152- ** agent_id:** ` uuid.UUID ` — Credal-generated Copilot ID to specify which agent to route the request to.
152+ ** agent_id:** ` uuid.UUID ` — Credal-generated Agent ID to specify which agent to route the request to.
153153
154154</dd >
155155</dl >
@@ -227,7 +227,7 @@ client.copilots.provide_message_feedback(
227227<dl >
228228<dd >
229229
230- ** agent_id:** ` uuid.UUID ` — Credal-generated Copilot ID to specify which agent to route the request to.
230+ ** agent_id:** ` uuid.UUID ` — Credal-generated Agent ID to specify which agent to route the request to.
231231
232232</dd >
233233</dl >
@@ -335,15 +335,15 @@ client.copilots.send_message(
335335<dl >
336336<dd >
337337
338- ** agent_id:** ` uuid.UUID ` — Credal-generated Copilot ID to specify which agent to route the request to.
338+ ** agent_id:** ` uuid.UUID ` — Credal-generated Agent ID to specify which agent to route the request to.
339339
340340</dd >
341341</dl >
342342
343343<dl >
344344<dd >
345345
346- ** message:** ` str ` — The message you want to send to your copilot .
346+ ** message:** ` str ` — The message you want to send to your agent .
347347
348348</dd >
349349</dl >
@@ -399,7 +399,7 @@ client.copilots.send_message(
399399<dl >
400400<dd >
401401
402- This endpoint allows you to send a message to a specific copilot and get the response back as a streamed set of Server-Sent Events.
402+ This endpoint allows you to send a message to a specific agent and get the response back as a streamed set of Server-Sent Events.
403403</dd >
404404</dl >
405405</dd >
@@ -450,7 +450,7 @@ response = client.copilots.stream_message(
450450 ),
451451 ],
452452)
453- for chunk in response:
453+ for chunk in response.data :
454454 yield chunk
455455
456456```
@@ -467,15 +467,15 @@ for chunk in response:
467467<dl >
468468<dd >
469469
470- ** copilot_id:** ` uuid.UUID ` — Credal-generated Copilot ID to specify which agent to route the request to.
470+ ** copilot_id:** ` uuid.UUID ` — Credal-generated Agent ID to specify which agent to route the request to.
471471
472472</dd >
473473</dl >
474474
475475<dl >
476476<dd >
477477
478- ** message:** ` str ` — The message you want to send to your copilot .
478+ ** message:** ` str ` — The message you want to send to your agent .
479479
480480</dd >
481481</dl >
@@ -531,7 +531,7 @@ for chunk in response:
531531<dl >
532532<dd >
533533
534- Link a collection with a copilot . The API Key used must be added to both the collection and the copilot beforehand.
534+ Link a collection with a agent . The API Key used must be added to both the collection and the agent beforehand.
535535</dd >
536536</dl >
537537</dd >
@@ -576,7 +576,7 @@ client.copilots.add_collection_to_copilot(
576576<dl >
577577<dd >
578578
579- ** copilot_id:** ` uuid.UUID ` — Credal-generated copilot ID to add the collection to.
579+ ** copilot_id:** ` uuid.UUID ` — Credal-generated Agent ID to add the collection to.
580580
581581</dd >
582582</dl >
@@ -616,7 +616,7 @@ client.copilots.add_collection_to_copilot(
616616<dl >
617617<dd >
618618
619- Unlink a collection with a copilot . The API Key used must be added to both the collection and the copilot beforehand.
619+ Unlink a collection with a agent . The API Key used must be added to both the collection and the agent beforehand.
620620</dd >
621621</dl >
622622</dd >
@@ -661,7 +661,7 @@ client.copilots.remove_collection_from_copilot(
661661<dl >
662662<dd >
663663
664- ** copilot_id:** ` uuid.UUID ` — Credal-generated copilot ID to add the collection to.
664+ ** copilot_id:** ` uuid.UUID ` — Credal-generated agent ID to add the collection to.
665665
666666</dd >
667667</dl >
@@ -701,7 +701,7 @@ client.copilots.remove_collection_from_copilot(
701701<dl >
702702<dd >
703703
704- Update the configuration for a copilot
704+ Update the configuration for a agent
705705</dd >
706706</dl >
707707</dd >
@@ -729,8 +729,8 @@ client.copilots.update_configuration(
729729 " 82e4b12a-6990-45d4-8ebd-85c00e030c24" ,
730730 ),
731731 configuration = Configuration(
732- name = " Customer Copilot " ,
733- description = " This copilot is used to answer customer requests based on internal documentation." ,
732+ name = " Customer Agent " ,
733+ description = " This agent is used to answer customer requests based on internal documentation." ,
734734 prompt = " You are a polite, helpful assistant used to answer customer requests." ,
735735 ai_endpoint_configuration = AiEndpointConfiguration(
736736 base_url = " https://api.openai.com/v1/" ,
@@ -753,7 +753,7 @@ client.copilots.update_configuration(
753753<dl >
754754<dd >
755755
756- ** copilot_id:** ` uuid.UUID ` — Credal-generated copilot ID to add the collection to.
756+ ** copilot_id:** ` uuid.UUID ` — Credal-generated agent ID to add the collection to.
757757
758758</dd >
759759</dl >
@@ -1348,7 +1348,7 @@ client.document_collections.remove_documents_from_collection(
13481348<dl >
13491349<dd >
13501350
1351- Create a new copilot . The API key used will be added to the copilot for future Requests
1351+ Create a new collection . The API key used will be added to the collection for future Requests
13521352</dd >
13531353</dl >
13541354</dd >
@@ -1402,15 +1402,15 @@ client.document_collections.create_collection(
14021402<dl >
14031403<dd >
14041404
1405- ** description:** ` str ` — An in depth name for the copilot 's function. Useful for routing requests to the right copilot .
1405+ ** description:** ` str ` — An in depth name for the agent 's function. Useful for routing requests to the right agent .
14061406
14071407</dd >
14081408</dl >
14091409
14101410<dl >
14111411<dd >
14121412
1413- ** collaborators:** ` typing.Sequence[Collaborator] ` — A list of collaborator emails and roles that will have access to the copilot .
1413+ ** collaborators:** ` typing.Sequence[Collaborator] ` — A list of collaborator emails and roles that will have access to the agent .
14141414
14151415</dd >
14161416</dl >
@@ -1516,7 +1516,7 @@ client.document_collections.delete_collection(
15161516<dl >
15171517<dd >
15181518
1519- Credal lets you easily sync your MongoDB data for use in Collections and Copilots . Create a new sync from a MongoDB collection to a Credal collection.
1519+ Credal lets you easily sync your MongoDB data for use in Collections and Agents . Create a new sync from a MongoDB collection to a Credal collection.
15201520</dd >
15211521</dl >
15221522</dd >
@@ -1622,7 +1622,7 @@ client.document_collections.create_mongo_collection_sync(
16221622<dl >
16231623<dd >
16241624
1625- Credal lets you easily sync your MongoDB data for use in Collections and Copilots . Update an existing sync from a MongoDB collection to a Credal collection via the ` mongoCredentialId ` , to disambiguate between multiple potential syncs to a given collection.
1625+ Credal lets you easily sync your MongoDB data for use in Collections and Agents . Update an existing sync from a MongoDB collection to a Credal collection via the ` mongoCredentialId ` , to disambiguate between multiple potential syncs to a given collection.
16261626</dd >
16271627</dl >
16281628</dd >
0 commit comments