Skip to main content

Range API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
rangeAssociateConversationGroundingTemporalRangeWorkstreamsPOST /range/{range}/conversations/grounding/temporal_range/workstreams/associate/{conversation}/range/{range}/conversations/grounding/temporal_range/workstreams/associate/{conversation} [POST]
rangeAssociateWorkstreamSummaryPOST /range/{range}/workstream_summaries/associate/{workstream_summary}/range/{range}/workstream_summaries/associate/{workstream_summary} [POST]
rangeDisassociateConversationGroundingTemporalRangeWorkstreamsPOST /range/{range}/conversations/grounding/temporal_range/workstreams/disassociate/{conversation}/range/{range}/conversations/grounding/temporal_range/workstreams/disassociate/{conversation} [POST]
rangeDisassociateWorkstreamSummaryPOST /range/{range}/workstream_summaries/disassociate/{workstream_summary}/range/{range}/workstream_summaries/disassociate/{workstream_summary} [POST]
rangeScoresIncrementPOST /range/{range}/scores/increment'/range/{range}/scores/increment' [POST]
rangeUpdatePOST /range/update/range/update [POST]
rangesSpecificRangeSnapshotGET /range/{range}/range/{range} [GET]

rangeAssociateConversationGroundingTemporalRangeWorkstreams

rangeAssociateConversationGroundingTemporalRangeWorkstreams(range, conversation)

/range/{range}/conversations/grounding/temporal_range/workstreams/associate/{conversation} [POST]

This will associate a range with a conversation(grounding.temporal.workstreams). This will do the same thing as the conversation equivalent.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = range_example; // String | This is a identifier that is used to identify a specific range.
final conversation = conversation_example; // String | This is the uuid of a conversation.

try {
api_instance.rangeAssociateConversationGroundingTemporalRangeWorkstreams(range, conversation);
} catch (e) {
print('Exception when calling RangeApi->rangeAssociateConversationGroundingTemporalRangeWorkstreams: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeStringThis is a identifier that is used to identify a specific range.
conversationStringThis is the uuid of a conversation.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

rangeAssociateWorkstreamSummary

rangeAssociateWorkstreamSummary(range, workstreamSummary)

/range/{range}/workstream_summaries/associate/{workstream_summary} [POST]

This will associate a range with a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = range_example; // String | This is a identifier that is used to identify a specific range.
final workstreamSummary = workstreamSummary_example; // String | This is a identifier that is used to identify a specific workstream_summary.

try {
api_instance.rangeAssociateWorkstreamSummary(range, workstreamSummary);
} catch (e) {
print('Exception when calling RangeApi->rangeAssociateWorkstreamSummary: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeStringThis is a identifier that is used to identify a specific range.
workstreamSummaryStringThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

rangeDisassociateConversationGroundingTemporalRangeWorkstreams

rangeDisassociateConversationGroundingTemporalRangeWorkstreams(range, conversation)

/range/{range}/conversations/grounding/temporal_range/workstreams/disassociate/{conversation} [POST]

This will enable us to disassociate a range from a conversation(grounding.temporal.workstreams). This will do the same thing as the conversation equivalent.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = range_example; // String | This is a identifier that is used to identify a specific range.
final conversation = conversation_example; // String | This is the uuid of a conversation.

try {
api_instance.rangeDisassociateConversationGroundingTemporalRangeWorkstreams(range, conversation);
} catch (e) {
print('Exception when calling RangeApi->rangeDisassociateConversationGroundingTemporalRangeWorkstreams: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeStringThis is a identifier that is used to identify a specific range.
conversationStringThis is the uuid of a conversation.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

rangeDisassociateWorkstreamSummary

rangeDisassociateWorkstreamSummary(range, workstreamSummary)

/range/{range}/workstream_summaries/disassociate/{workstream_summary} [POST]

This will enable us to disassociate a range from a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = range_example; // String | This is a identifier that is used to identify a specific range.
final workstreamSummary = workstreamSummary_example; // String | This is a identifier that is used to identify a specific workstream_summary.

try {
api_instance.rangeDisassociateWorkstreamSummary(range, workstreamSummary);
} catch (e) {
print('Exception when calling RangeApi->rangeDisassociateWorkstreamSummary: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeStringThis is a identifier that is used to identify a specific range.
workstreamSummaryStringThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

rangeScoresIncrement

rangeScoresIncrement(range, seededScoreIncrement)

'/range/{range}/scores/increment' [POST]

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = range_example; // String | This is a identifier that is used to identify a specific range.
final seededScoreIncrement = SeededScoreIncrement(); // SeededScoreIncrement |

try {
api_instance.rangeScoresIncrement(range, seededScoreIncrement);
} catch (e) {
print('Exception when calling RangeApi->rangeScoresIncrement: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeStringThis is a identifier that is used to identify a specific range.
seededScoreIncrementSeededScoreIncrement[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

rangeUpdate

Range rangeUpdate(range)

/range/update [POST]

This will update a specific range.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = Range(); // Range |

try {
final result = api_instance.rangeUpdate(range);
print(result);
} catch (e) {
print('Exception when calling RangeApi->rangeUpdate: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeRange[optional]

Return type

Range

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

rangesSpecificRangeSnapshot

Range rangesSpecificRangeSnapshot(range)

/range/{range} [GET]

This will get a snapshot of a single range.

Example

import 'package:core_openapi/api.dart';

final api_instance = RangeApi();
final range = range_example; // String | This is a identifier that is used to identify a specific range.

try {
final result = api_instance.rangesSpecificRangeSnapshot(range);
print(result);
} catch (e) {
print('Exception when calling RangeApi->rangesSpecificRangeSnapshot: $e\n');
}

Parameters

NameTypeDescriptionNotes
rangeStringThis is a identifier that is used to identify a specific range.

Return type

Range

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain