OpenAIStreamedServiceFactory

io.cequence.openaiscala.service.OpenAIStreamedServiceFactory$
object OpenAIStreamedServiceFactory extends OpenAIServiceFactoryHelper[OpenAIStreamedServiceExtra]

Attributes

Graph
Supertypes
trait OpenAIServiceFactoryHelper[OpenAIStreamedServiceExtra]
trait OpenAIServiceConsts
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Inherited classlikes

Attributes

Inherited from:
OpenAIServiceConsts
Graph
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

override def customInstance(coreUrl: String, authHeaders: Seq[(String, String)], extraParams: Seq[(String, String)], timeouts: Option[Timeouts])(implicit ec: ExecutionContext, materializer: Materializer): OpenAIStreamedServiceExtra

Attributes

Definition Classes
OpenAIServiceFactoryHelper

Inherited methods

def apply(config: Config)(implicit ec: ExecutionContext, materializer: Materializer): F

Attributes

Inherited from:
OpenAIServiceFactoryHelper
def apply()(implicit ec: ExecutionContext, materializer: Materializer): F

Attributes

Inherited from:
OpenAIServiceFactoryHelper
def apply(apiKey: String, orgId: Option[String], timeouts: Option[Timeouts])(implicit ec: ExecutionContext, materializer: Materializer): F

Attributes

Inherited from:
OpenAIServiceFactoryHelper
def forAzureWithApiKey(resourceName: String, deploymentId: String, apiVersion: String, apiKey: String, timeouts: Option[Timeouts])(implicit ec: ExecutionContext, materializer: Materializer): F

Create an OpenAI Service for Azure using an API key.

Create an OpenAI Service for Azure using an API key.

Note that not all endpoints are supported! Check the Azure OpenAI API documentation for more information.

Attributes

apiVersion

The API version to use for this operation. This follows the YYYY-MM-DD format. Supported versions: 2023-03-15-preview, 2022-12-01, 2023-05-15, and 2023-06-01-preview

deploymentId

The deployment name you chose when you deployed the model.

resourceName

The name of your Azure OpenAI Resource.

Inherited from:
OpenAIServiceFactoryHelper

Deprecated and Inherited methods

@Deprecated
def forAzureWithAccessToken(resourceName: String, deploymentId: String, apiVersion: String, accessToken: String, timeouts: Option[Timeouts])(implicit ec: ExecutionContext, materializer: Materializer): F

Create an OpenAI Service for Azure using an access token (Azure Active Directory authentication).

Create an OpenAI Service for Azure using an access token (Azure Active Directory authentication).

Note that not all endpoints are supported! Check the Azure OpenAI API documentation for more information.

Attributes

apiVersion

The API version to use for this operation. This follows the YYYY-MM-DD format. Supported versions: 2023-03-15-preview, 2022-12-01, 2023-05-15, and 2023-06-01-preview

deploymentId

The deployment name you chose when you deployed the model.

resourceName

The name of your Azure OpenAI Resource.

Deprecated
true
Inherited from:
OpenAIServiceFactoryHelper

Inherited fields

protected val configFileName: String

Attributes

Inherited from:
OpenAIServiceConsts
protected val configPrefix: String

Attributes

Inherited from:
OpenAIServiceConsts
protected val defaultCoreUrl: String

Attributes

Inherited from:
OpenAIServiceConsts