import 'package:pieces_os_client/api.dart';All URIs are relative to http://localhost:3000
| Method | HTTP request | Description |
|---|---|---|
| conversationsCreateFromAsset | POST /conversations/create/from_asset/{asset} | /conversations/create/from_asset/{asset} [POST] |
| conversationsCreateSpecificConversation | POST /conversations/create | /conversations/create [POST] |
| conversationsDeleteSpecificConversation | POST /conversations/{conversation}/delete | /conversations/{conversation}/delete [POST] |
| conversationsIdentifiersSnapshot | GET /conversations/identifiers | /conversations/identifiers [GET] |
| conversationsSnapshot | GET /conversations | /conversations [GET] |
| conversationsStreamIdentifiers | GET /conversations/stream/identifiers | /conversations/stream/identifiers [STREAMED] |
ConversationsCreateFromAssetOutput conversationsCreateFromAsset(asset)
/conversations/create/from_asset/{asset} [POST]
This will create a conversation from an asset, This will create a conversation and an initial message for the conversation(w/ a summary of the asset that is being used as grounding context).
import 'package:pieces_os_client/api.dart';
final api_instance = ConversationsApi();
final asset = 2254f2c8-5797-40e8-ac56-41166dc0e159; // String | The id (uuid) of the asset that you are trying to access.
try {
final result = api_instance.conversationsCreateFromAsset(asset);
print(result);
} catch (e) {
print('Exception when calling ConversationsApi->conversationsCreateFromAsset: $e\n');
}| Name | Type | Description | Notes |
|---|---|---|---|
| asset | String | The id (uuid) of the asset that you are trying to access. |
ConversationsCreateFromAssetOutput
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Conversation conversationsCreateSpecificConversation(transferables, seededConversation)
/conversations/create [POST]
This will create a specific conversation.
import 'package:pieces_os_client/api.dart';
final api_instance = ConversationsApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
final seededConversation = SeededConversation(); // SeededConversation |
try {
final result = api_instance.conversationsCreateSpecificConversation(transferables, seededConversation);
print(result);
} catch (e) {
print('Exception when calling ConversationsApi->conversationsCreateSpecificConversation: $e\n');
}| Name | Type | Description | Notes |
|---|---|---|---|
| transferables | bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] |
| seededConversation | SeededConversation | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
conversationsDeleteSpecificConversation(conversation)
/conversations/{conversation}/delete [POST]
This will delete a specific Conversation.
import 'package:pieces_os_client/api.dart';
final api_instance = ConversationsApi();
final conversation = conversation_example; // String | This is the uuid of a conversation.
try {
api_instance.conversationsDeleteSpecificConversation(conversation);
} catch (e) {
print('Exception when calling ConversationsApi->conversationsDeleteSpecificConversation: $e\n');
}| Name | Type | Description | Notes |
|---|---|---|---|
| conversation | String | This is the uuid of a conversation. |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FlattenedConversations conversationsIdentifiersSnapshot()
/conversations/identifiers [GET]
This will get all the uuids of a Conversation.
import 'package:pieces_os_client/api.dart';
final api_instance = ConversationsApi();
try {
final result = api_instance.conversationsIdentifiersSnapshot();
print(result);
} catch (e) {
print('Exception when calling ConversationsApi->conversationsIdentifiersSnapshot: $e\n');
}This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Conversations conversationsSnapshot(transferables)
/conversations [GET]
This will return a snapshot of a specific conversation
import 'package:pieces_os_client/api.dart';
final api_instance = ConversationsApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
try {
final result = api_instance.conversationsSnapshot(transferables);
print(result);
} catch (e) {
print('Exception when calling ConversationsApi->conversationsSnapshot: $e\n');
}| Name | Type | Description | Notes |
|---|---|---|---|
| transferables | bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
conversationsStreamIdentifiers()
/conversations/stream/identifiers [STREAMED]
This is a stream for the conversation identifiers. will return StreamedIdentifiers.
import 'package:pieces_os_client/api.dart';
final api_instance = ConversationsApi();
try {
api_instance.conversationsStreamIdentifiers();
} catch (e) {
print('Exception when calling ConversationsApi->conversationsStreamIdentifiers: $e\n');
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]