ExStreamClient.Operations.Chat.Segments (ExStreamClient v0.1.0)

View Source
Modules for interacting with the `chat/segments` group of OpenAI APIs

API Reference: https://platform.openai.com/docs/api-reference/chat/segments

Summary

Functions

delete_segment(id)

@spec delete_segment(String.t()) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Delete a segment


### Required Arguments:
    - `id`

delete_segment_targets(id, payload)

@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

get_segment(id)

@spec get_segment(String.t()) ::
  {:ok, ExStreamClient.Model.GetSegmentResponse.t()} | {:error, any()}
Get segment


### Required Arguments:
    - `id`

query_segment_targets(id, payload)

Query segment targets


### Required Arguments:
    - `id`
    - `payload`: QuerySegmentTargetsRequest

query_segments(payload)

Query segments


### Required Arguments:
    - `payload`: QuerySegmentsRequest

segment_target_exists(id, target_id)

@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`