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 classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : kotlin.String = range_example // kotlin.String | This is a identifier that is used to identify a specific range.
val conversation : kotlin.String = conversation_example // kotlin.String | This is the uuid of a conversation.
try {
apiInstance.rangeAssociateConversationGroundingTemporalRangeWorkstreams(range, conversation)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangeAssociateConversationGroundingTemporalRangeWorkstreams")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangeAssociateConversationGroundingTemporalRangeWorkstreams")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
rangekotlin.StringThis is a identifier that is used to identify a specific range.
conversationkotlin.StringThis is the uuid of a conversation.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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 classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : kotlin.String = range_example // kotlin.String | This is a identifier that is used to identify a specific range.
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
try {
apiInstance.rangeAssociateWorkstreamSummary(range, workstreamSummary)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangeAssociateWorkstreamSummary")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangeAssociateWorkstreamSummary")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
rangekotlin.StringThis is a identifier that is used to identify a specific range.
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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 classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : kotlin.String = range_example // kotlin.String | This is a identifier that is used to identify a specific range.
val conversation : kotlin.String = conversation_example // kotlin.String | This is the uuid of a conversation.
try {
apiInstance.rangeDisassociateConversationGroundingTemporalRangeWorkstreams(range, conversation)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangeDisassociateConversationGroundingTemporalRangeWorkstreams")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangeDisassociateConversationGroundingTemporalRangeWorkstreams")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
rangekotlin.StringThis is a identifier that is used to identify a specific range.
conversationkotlin.StringThis is the uuid of a conversation.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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 classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : kotlin.String = range_example // kotlin.String | This is a identifier that is used to identify a specific range.
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
try {
apiInstance.rangeDisassociateWorkstreamSummary(range, workstreamSummary)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangeDisassociateWorkstreamSummary")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangeDisassociateWorkstreamSummary")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
rangekotlin.StringThis is a identifier that is used to identify a specific range.
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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 classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : kotlin.String = range_example // kotlin.String | This is a identifier that is used to identify a specific range.
val seededScoreIncrement : SeededScoreIncrement = // SeededScoreIncrement |
try {
apiInstance.rangeScoresIncrement(range, seededScoreIncrement)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangeScoresIncrement")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangeScoresIncrement")
e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

rangeUpdate

Range rangeUpdate(range)

/range/update [POST]

This will update a specific range.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : Range = // Range |
try {
val result : Range = apiInstance.rangeUpdate(range)
println(result)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangeUpdate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangeUpdate")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
rangeRange[optional]

Return type

Range

Authorization

No authorization required

HTTP request headers

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

rangesSpecificRangeSnapshot

Range rangesSpecificRangeSnapshot(range)

/range/{range} [GET]

This will get a snapshot of a single range.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = RangeApi()
val range : kotlin.String = range_example // kotlin.String | This is a identifier that is used to identify a specific range.
try {
val result : Range = apiInstance.rangesSpecificRangeSnapshot(range)
println(result)
} catch (e: ClientException) {
println("4xx response calling RangeApi#rangesSpecificRangeSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RangeApi#rangesSpecificRangeSnapshot")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
rangekotlin.StringThis 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