Class OrchestrationStream<Item>

constructor

• new OrchestrationStream<Item>(
      iterator: () => AsyncIterator<Item>,
      controller: AbortController,
  ): OrchestrationStream<Item>

  Type Parameters

  • Item

  Parameters

  • iterator: () => AsyncIterator<Item>
  • controller: AbortController

  Returns OrchestrationStream<Item>

iterator

_pipe

• _pipe<TReturn>(
      processFn: (
          stream: OrchestrationStream<Item>,
          response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>,
      ) => AsyncIterator<TReturn>,
      response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>,
  ): OrchestrationStream<TReturn>
  Internal

  Pipe the stream through a processing function.

  Type Parameters

  • TReturn

  Parameters

  • processFn: (
        stream: OrchestrationStream<Item>,
        response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>,
    ) => AsyncIterator<TReturn>

    The function to process the input stream.

  • Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>

    The OrchestrationStreamResponse object for process function to store finish reason, token usage, etc.

  Returns OrchestrationStream<TReturn>

  The output stream containing processed items.

toContentStream

• toContentStream(
      this: OrchestrationStream<OrchestrationStreamChunkResponse>,
  ): OrchestrationStream<string>

  Transform the stream of chunks into a stream of content strings.

  Parameters

  • this: OrchestrationStream<OrchestrationStreamChunkResponse>

    Orchestration stream.

  Returns OrchestrationStream<string>

  A stream of content strings.

Static_create

• _create(
      response: HttpResponse,
      controller: AbortController,
  ): OrchestrationStream<CompletionPostResponseStreaming>
  Internal

  Create an orchestration stream based on the http response.

  Parameters

  • response: HttpResponse

    Http response.

  • controller: AbortController

  Returns OrchestrationStream<CompletionPostResponseStreaming>

  An orchestration stream.

Static_processChunk

• _processChunk(
      stream: OrchestrationStream<CompletionPostResponseStreaming>,
  ): AsyncGenerator<OrchestrationStreamChunkResponse>
  Internal

  Wrap raw chunk data with chunk response class to provide helper functions.

  Parameters

  • stream: OrchestrationStream<CompletionPostResponseStreaming>

    Orchestration stream.

  Returns AsyncGenerator<OrchestrationStreamChunkResponse>

Static_processContentStream

• _processContentStream(
      stream: OrchestrationStream<OrchestrationStreamChunkResponse>,
  ): AsyncGenerator<string>
  Internal

  Transform a stream of chunks into a stream of content strings.

  Parameters

  • stream: OrchestrationStream<OrchestrationStreamChunkResponse>

    Orchestration stream.

  Returns AsyncGenerator<string>

Static_processOrchestrationStreamChunkResponse

• _processOrchestrationStreamChunkResponse(
      stream: OrchestrationStream<OrchestrationStreamChunkResponse>,
      response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>,
  ): AsyncGenerator<OrchestrationStreamChunkResponse>

  Parameters

  • stream: OrchestrationStream<OrchestrationStreamChunkResponse>
  • Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>

  Returns AsyncGenerator<OrchestrationStreamChunkResponse>

Static_processStreamEnd

• _processStreamEnd(
      stream: OrchestrationStream<OrchestrationStreamChunkResponse>,
      response?: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>,
  ): AsyncGenerator<OrchestrationStreamChunkResponse>

  Parameters

  • stream: OrchestrationStream<OrchestrationStreamChunkResponse>
  • Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>

  Returns AsyncGenerator<OrchestrationStreamChunkResponse>