vectorProvider - APEXlang Reference

`vectorProvider`

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 Enter a descriptive name for this Vector Provider.
`type`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `databaseOnnxModel` `genAIService` `customPlsql`

Property Groups:

localEmbedding

Property	Type	Required	Details
`owner`	`string`	No	data type=`string`; maxLen=32767 Applies when`type = databaseOnnxModel`
`modelName`	`string`	Yes	data type=`string`; maxLen=32767 Applies when`type = databaseOnnxModel`
`function`	`string`	Yes	data type=`string`; maxLen=255 Applies when`type = customPlsql`

localEmbedding {
  owner: value
  modelName: value
  function: value
}

genAIService

Property	Type	Required	Default Value	Details
`provider`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `ociGenAI` `openai` `cohere` `googleGemini` `mistralAi` `ollama` `genericOpenaiApiCompatible` Applies when`type = genAIService`
`modelName`	`string`	No		data type=`string`; maxLen=255 Applies when`type = genAIService`

genAIService {
  provider: ociGenAI
  modelName: value
}

ociGenAI

Property	Type	Required	Details
`compartmentId`	`string`	Yes	data type=`string`; maxLen=255 Applies when`type = genAIService and provider = ociGenAI`
`servingMode`	`enum`	Yes	data type=`string`; lov=`STATIC` Valid values: `onDemand` `dedicated` Applies when`type = genAIService and provider = ociGenAI`
`endpointId`	`string`	No	data type=`string`; maxLen=255 Applies when`type = genAIService and provider = ociGenAI`

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

endpointUrl

Property	Type	Required	Default Value	Details
`url`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type = genAIService` Enter the endpoint URL for this Vector Provider.

endpointUrl {
  url: value
}

authentication

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

authentication {
  credentials: @component
}

additionalData

Property	Type	Required	Default Value	Details
`httpHeaders`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`type = genAIService`
`attributes`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`type = genAIService and provider = ociGenAI`

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

advanced

Property	Type	Required	Details
`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 Vector Provider. Please note that not every Vector Provider 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 Vector Provider in seconds.
`staticId`	`string`	Yes	data type=`string`; maxLen=255 Use the Static ID to reference the Vector Provider in API Calls. Static IDs are also used to identify an existing Vector Provider when the application is being exported and imported to another workspace.

advanced {
  maxTokens: 42
  serverTimeout: 42
  staticId: value
}

comments

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

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

APEXlang Example

vectorProvider sample (
    name: value
    type: databaseOnnxModel
    localEmbedding {
        owner: value
        modelName: value
        function: value
    }
    genAIService {
        provider: ociGenAI
        modelName: value
    }
    ociGenAI {
        compartmentId: value
        servingMode: onDemand
        endpointId: value
    }
    endpointUrl {
        url: value
    }
    authentication {
        credentials: @component
    }
    additionalData {
        httpHeaders: ```
          value
        ```
        attributes: ```
          value
        ```
    }
    advanced {
        maxTokens: 42
        serverTimeout: 42
        staticId: value
    }
    comments {
        comments: ```
          value
        ```
    }
)