Package de.xima.fc.prompt.ms.impl.service.generic_oai.client.model

Class TestConnectionOutput

java.lang.Object

de.xima.fc.prompt.ms.impl.service.generic_oai.client.model.BaseOutput

de.xima.fc.prompt.ms.impl.service.generic_oai.client.model.TestConnectionOutput

public final class TestConnectionOutput
extends BaseOutput

The output of a list models request, contains a list of available model IDs.

Since:

8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestConnectionOutput.Builder	Builder for TestConnectionOutput.

Method Summary

Modifier and Type	Method	Description
String	answer()	Gets the answer that was returned by the model in response to the test prompt.
static TestConnectionOutput.Builder	builder()	Creates a new builder for list models output instance.
static TestConnectionOutput	error(GenericOaiErrorType type, String errorMessage, Throwable cause)	Creates a TestConnectionOutput representing an error.

Methods inherited from class de.xima.fc.prompt.ms.impl.service.generic_oai.client.model.BaseOutput

errorCause, errorMessage, errorType, hasError

Methods inherited from class java.lang.Object

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

Method Detail

answer

public String answer()

Gets the answer that was returned by the model in response to the test prompt.

Returns:

The model's answer.

builder

public static TestConnectionOutput.Builder builder()

Creates a new builder for list models output instance.

Returns:

The builder.

error

public static TestConnectionOutput error(GenericOaiErrorType type,
                                         String errorMessage,
                                         Throwable cause)

Creates a TestConnectionOutput representing an error.

Parameters:

type - The type of error.

errorMessage - A descriptive error message.

cause - The underlying exception that caused the error.

Returns:

An ask response instance representing the error.