Package bg.codexio.ai.openai.api.payload.credentials

Record Class ApiCredentials

java.lang.Object

java.lang.Record

bg.codexio.ai.openai.api.payload.credentials.ApiCredentials

Record Components:

apiKey - generated in OpenAI user settings page

organization - optional organization, default organization can be configured in OpenAI user settings page

baseUrl - optional base url for the API calls, default one is https://api.openai.com/v1

public record ApiCredentials(String apiKey, String organization, String baseUrl)
extends Record

This configuration is used to define the credentials used for auth in the OpenAI API

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URL

Constructor Summary

Constructors

Constructor	Description
ApiCredentials(String apiKey)	Generates credential object with supplied apiKey, default base url and empty organization
ApiCredentials(String apiKey, String organization, String baseUrl)	Creates an instance of a ApiCredentials record class.

Method Summary

Modifier and Type	Method	Description
String	apiKey()	Returns the value of the apiKey record component.
String	baseUrl()	Returns the value of the baseUrl record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	organization()	Returns the value of the organization record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

BASE_URL

public static final String BASE_URL

See Also:

• Constant Field Values

Constructor Details

ApiCredentials

public ApiCredentials(String apiKey)

Generates credential object with supplied apiKey, default base url and empty organization

Parameters:

apiKey - generated in OpenAI user settings page

ApiCredentials

public ApiCredentials(String apiKey,
 String organization,
 String baseUrl)

Creates an instance of a ApiCredentials record class.

Parameters:

apiKey - the value for the apiKey record component

organization - the value for the organization record component

baseUrl - the value for the baseUrl record component

Method Details

baseUrl

public String baseUrl()

Returns the value of the baseUrl record component.

Returns:

the value of the baseUrl record component

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

apiKey

public String apiKey()

Returns the value of the apiKey record component.

Returns:

the value of the apiKey record component

organization

public String organization()

Returns the value of the organization record component.

Returns:

the value of the organization record component