ExStreamClient.Operations.Chat.Segments (ExStreamClient v0.1.0)
View SourceModules for interacting with the `chat/segments` group of OpenAI APIs
API Reference: https://platform.openai.com/docs/api-reference/chat/segments
Summary
Functions
@spec delete_segment(String.t()) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Delete a segment
### Required Arguments:
- `id`
@spec delete_segment_targets( String.t(), ExStreamClient.Model.DeleteSegmentTargetsRequest.t() ) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Delete targets from a segment
### Required Arguments:
- `id`
- `payload`: DeleteSegmentTargetsRequest
@spec get_segment(String.t()) :: {:ok, ExStreamClient.Model.GetSegmentResponse.t()} | {:error, any()}
Get segment
### Required Arguments:
- `id`
@spec query_segment_targets( String.t(), ExStreamClient.Model.QuerySegmentTargetsRequest.t() ) :: {:ok, ExStreamClient.Model.QuerySegmentTargetsResponse.t()} | {:error, any()}
Query segment targets
### Required Arguments:
- `id`
- `payload`: QuerySegmentTargetsRequest
@spec query_segments(ExStreamClient.Model.QuerySegmentsRequest.t()) :: {:ok, ExStreamClient.Model.QuerySegmentsResponse.t()} | {:error, any()}
Query segments
### Required Arguments:
- `payload`: QuerySegmentsRequest
@spec segment_target_exists(String.t(), String.t()) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise
### Required Arguments:
- `id`
- `target_id`