genAIService - APEXlang Reference

`genAIService`

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 Enter a descriptive name for this Generative AI Service.
`provider`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `ociGenAI` `openai` `cohere` `googleGemini` `anthropicClaude` `mistralAi` `ollama` `genericOpenaiApiCompatible`

Property Groups:

ociGenAI

Property	Type	Required	Details
`compartmentId`	`string`	Yes	data type=`string`; maxLen=255 Applies when`provider = ociGenAI`
`servingMode`	`enum`	Yes	data type=`string`; lov=`STATIC` Valid values: `onDemand` `dedicated` Applies when`provider = ociGenAI`
`endpointId`	`string`	Yes	data type=`string`; maxLen=255 Applies when`provider = ociGenAI and servingMode = dedicated`
`projectId`	`string`	Yes	data type=`string`; maxLen=255 Applies when`provider = ociGenAI and provider in (openai) and providerApi = responsesprovider = ociGenAI and provider in (genericOpenaiApiCompatible) and providerApi = responsesprovider = ociGenAI and provider in (ollama) and providerApi = responsesprovider = ociGenAI and provider in (ociGenAI) and providerApi = responsesprovider = ociGenAI and provider in (googleGemini) and providerApi = responses`

ociGenAI {
  compartmentId: value
  servingMode: onDemand
  endpointId: value
  projectId: value
}

endpointUrl

Property	Type	Required	Default Value	Details
`url`	`string`	Yes		data type=`string`; maxLen=4000 Enter the endpoint URL for this Generative AI Service.

endpointUrl {
  url: value
}

authentication

Property	Type	Required	Default Value	Details
`credentials`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`webCredential`

authentication {
  credentials: @component
}

additionalData

Property	Type	Required	Default Value	Details
`httpHeaders`	`multiline string`	No		data type=`multiline string`; maxLen=4000
`attributes`	`multiline string`	No		data type=`multiline string`; maxLen=4000

additionalData {
  httpHeaders: ```
    value
  ```
  attributes: ```
    value
  ```
}

appBuilder

Property	Type	Required	Default Value	Details
`usedByAppBuilder`	`boolean`	Yes	`false`	data type=`boolean`
`defaultForNewApps`	`boolean`	Yes	`false`	data type=`boolean`

appBuilder {
  usedByAppBuilder: false
  defaultForNewApps: false
}

advanced

Property	Type	Required	Details
`modelName`	`string`	No	data type=`string`; maxLen=255
`maxTokens`	`integer`	No	data type=`integer`; maxLen=32767 Enter the maximum number of AI Tokens per rolling 24 hour period that Oracle APEX can use for this Generative AI Service. Please note that not every Generative AI Service supports token usage information, so it might be possible that &PRODUCT_NAME can't enforce this limit.
`serverTimeout`	`integer`	No	data type=`integer`; maxLen=32767 Defines the transfer timeout for communicating with the Generative AI Service in seconds.
`staticId`	`string`	Yes	data type=`string`; maxLen=255 Use the Static ID to reference the Generative AI Service in API Calls. Static IDs are also used to identify an existing Generative AI Service when the application is being exported and imported to another workspace.
`providerApi`	`enum`	Yes	data type=`string`; lov=`STATIC` Valid values: `responses` `generic` `interactions` `chatCompletions` `generateText` Applies when`provider in (openai)provider in (genericOpenaiApiCompatible)provider in (ollama)provider in (ociGenAI)provider in (googleGemini)`

advanced {
  modelName: value
  maxTokens: 42
  serverTimeout: 42
  staticId: value
  providerApi: responses
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

genAIService sample (
    name: value
    provider: ociGenAI
    ociGenAI {
        compartmentId: value
        servingMode: onDemand
        endpointId: value
        projectId: value
    }
    endpointUrl {
        url: value
    }
    authentication {
        credentials: @component
    }
    additionalData {
        httpHeaders: ```
          value
        ```
        attributes: ```
          value
        ```
    }
    appBuilder {
        usedByAppBuilder: false
        defaultForNewApps: false
    }
    advanced {
        modelName: value
        maxTokens: 42
        serverTimeout: 42
        staticId: value
        providerApi: responses
    }
    comments {
        comments: ```
          value
        ```
    }
)