com.coze.loop.client

Class CozeLoopClientImpl

java.lang.Object

com.coze.loop.client.CozeLoopClientImpl

All Implemented Interfaces:

CozeLoopClient, AutoCloseable

public class CozeLoopClientImpl
extends Object
implements CozeLoopClient

Implementation of CozeLoopClient.

Constructor Summary

Constructors

Constructor and Description
CozeLoopClientImpl(String workspaceId, CozeLoopTracerProvider tracerProvider, PromptProvider promptProvider, HttpClient httpClient)

Method Summary

Modifier and Type	Method and Description
void	close() Close the client (alias for shutdown).
ExecuteResult	execute(ExecuteParam param) Execute a prompt.
StreamReader<ExecuteResult>	executeStreaming(ExecuteParam param) Execute a prompt with streaming response.
CozeLoopContext	extractContext(Map<String,String> headers) Extract context from headers for cross-service propagation.
void	flush() Flush all pending spans to the backend.
List<Message>	formatPrompt(Prompt prompt, Map<String,Object> variables) Format a prompt with variables.
List<Message>	getAndFormatPrompt(GetPromptParam param, Map<String,Object> variables) Get and format a prompt in one call.
Prompt	getPrompt(GetPromptParam param) Get a prompt from the platform.
String	getWorkspaceId() Get the workspace ID.
void	invalidatePromptCache(GetPromptParam param) Invalidate cached prompt.
void	shutdown() Shutdown the client and release resources.
CozeLoopSpan	startSpan(String name) Start a new span with default type "custom".
CozeLoopSpan	startSpan(String name, String spanType) Start a new span with specified type.
CozeLoopSpan	startSpan(String name, String spanType, CozeLoopContext parentContext) Start a new span with specified type and parent context.
CozeLoopSpan	startSpan(String name, String spanType, CozeLoopContext parentContext, String scene)
CozeLoopSpan	startSpan(String name, String spanType, CozeLoopSpan parentSpan) Start a new span with specified type.
CozeLoopSpan	startSpan(String name, String spanType, CozeLoopSpan parentSpan, String scene)
CozeLoopSpan	startSpan(String name, String spanType, String scene)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CozeLoopClientImpl

public CozeLoopClientImpl(String workspaceId,
                          CozeLoopTracerProvider tracerProvider,
                          PromptProvider promptProvider,
                          HttpClient httpClient)

Method Detail

startSpan

public CozeLoopSpan startSpan(String name)

Description copied from interface: CozeLoopClient

Start a new span with default type "custom".

Specified by:

startSpan in interface CozeLoopClient

Parameters:

name - the span name

Returns:

the span wrapper

startSpan

public CozeLoopSpan startSpan(String name,
                              String spanType)

Description copied from interface: CozeLoopClient

Start a new span with specified type.

Specified by:

startSpan in interface CozeLoopClient

Parameters:

name - the span name

spanType - the span type (e.g., "llm", "tool", "custom")

Returns:

the span wrapper

startSpan

public CozeLoopSpan startSpan(String name,
                              String spanType,
                              String scene)

Specified by:

startSpan in interface CozeLoopClient

startSpan

public CozeLoopSpan startSpan(String name,
                              String spanType,
                              CozeLoopSpan parentSpan)

Description copied from interface: CozeLoopClient

Start a new span with specified type.

Specified by:

startSpan in interface CozeLoopClient

Parameters:

name - the span name

spanType - the span type (e.g., "llm", "tool", "custom")

Returns:

the span wrapper

startSpan

public CozeLoopSpan startSpan(String name,
                              String spanType,
                              CozeLoopSpan parentSpan,
                              String scene)

Specified by:

startSpan in interface CozeLoopClient

startSpan

public CozeLoopSpan startSpan(String name,
                              String spanType,
                              CozeLoopContext parentContext)

Description copied from interface: CozeLoopClient

Start a new span with specified type and parent context. Useful for cross-service tracing where you have an extracted Context.

Specified by:

startSpan in interface CozeLoopClient

Parameters:

name - the span name

spanType - the span type

parentContext - the parent context

Returns:

the span wrapper

startSpan

public CozeLoopSpan startSpan(String name,
                              String spanType,
                              CozeLoopContext parentContext,
                              String scene)

Specified by:

startSpan in interface CozeLoopClient

extractContext

public CozeLoopContext extractContext(Map<String,String> headers)

Description copied from interface: CozeLoopClient

Extract context from headers for cross-service propagation.

Specified by:

extractContext in interface CozeLoopClient

Parameters:

headers - the map of headers (e.g. from an incoming HTTP request)

Returns:

the extracted context

getPrompt

public Prompt getPrompt(GetPromptParam param)

Description copied from interface: CozeLoopClient

Get a prompt from the platform.

Specified by:

getPrompt in interface CozeLoopClient

Parameters:

param - the parameters for getting prompt

Returns:

prompt

formatPrompt

public List<Message> formatPrompt(Prompt prompt,
                                  Map<String,Object> variables)

Description copied from interface: CozeLoopClient

Format a prompt with variables.

Specified by:

formatPrompt in interface CozeLoopClient

Parameters:

prompt - the prompt to format

variables - the variables to substitute

Returns:

formatted messages

getAndFormatPrompt

public List<Message> getAndFormatPrompt(GetPromptParam param,
                                        Map<String,Object> variables)

Description copied from interface: CozeLoopClient

Get and format a prompt in one call.

Specified by:

getAndFormatPrompt in interface CozeLoopClient

Parameters:

param - the parameters for getting prompt

variables - the variables to substitute

Returns:

formatted messages

invalidatePromptCache

public void invalidatePromptCache(GetPromptParam param)

Description copied from interface: CozeLoopClient

Invalidate cached prompt.

Specified by:

invalidatePromptCache in interface CozeLoopClient

Parameters:

param - the parameters identifying the prompt

execute

public ExecuteResult execute(ExecuteParam param)

Description copied from interface: CozeLoopClient

Execute a prompt.

Specified by:

execute in interface CozeLoopClient

Parameters:

param - the execution parameters

Returns:

the execution result

executeStreaming

public StreamReader<ExecuteResult> executeStreaming(ExecuteParam param)

Description copied from interface: CozeLoopClient

Execute a prompt with streaming response.

Specified by:

executeStreaming in interface CozeLoopClient

Parameters:

param - the execution parameters

Returns:

stream reader for ExecuteResult

getWorkspaceId

public String getWorkspaceId()

Description copied from interface: CozeLoopClient

Get the workspace ID.

Specified by:

getWorkspaceId in interface CozeLoopClient

Returns:

workspace ID

flush

public void flush()

Description copied from interface: CozeLoopClient

Flush all pending spans to the backend.

Specified by:

flush in interface CozeLoopClient

shutdown

public void shutdown()

Description copied from interface: CozeLoopClient

Shutdown the client and release resources. This method flushes all pending spans and closes HTTP connections.

Specified by:

shutdown in interface CozeLoopClient

close

public void close()

Description copied from interface: CozeLoopClient

Close the client (alias for shutdown).

Specified by:

close in interface CozeLoopClient

Specified by:

close in interface AutoCloseable