generativeaiagent.oracle.com/v1beta1
Back to API Reference
APIVersion: generativeaiagent.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes generativeaiagent.oracle.com/v1beta1.
Resources
Agent
Manage OCI Generative AI Agents.
Plural: agentsScope: NamespacedAPIVersion: generativeaiagent.oracle.com/v1beta1Sample: Sample (config/samples/generativeaiagent_v1beta1_agent.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
AgentSpec defines the desired state of Agent.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the agent in. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
Description about the agent. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
knowledgeBaseIds |
List of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. |
list[string] |
No |
- |
- |
llmConfig |
AgentLlmConfig defines nested fields for Agent.LlmConfig. |
object |
No |
- |
- |
welcomeMessage |
Details about purpose and responsibility of the agent |
string |
No |
- |
- |
Spec.llmConfig
Back to Agent spec
AgentLlmConfig defines nested fields for Agent.LlmConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
routingLlmCustomization |
AgentLlmConfigRoutingLlmCustomization defines nested fields for Agent.LlmConfig.RoutingLlmCustomization. |
object |
No |
- |
- |
runtimeVersion |
The runtimeVersion of the system prompt. |
string |
No |
- |
- |
Spec.llmConfig.routingLlmCustomization
Back to Agent spec
AgentLlmConfigRoutingLlmCustomization defines nested fields for Agent.LlmConfig.RoutingLlmCustomization.
| Field |
Description |
Type |
Required |
Default |
Enum |
instruction |
If specified, the default instruction is replaced with provided instruction. |
string |
No |
- |
- |
llmHyperParameters |
Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. |
map[string, object (preserves unknown fields)] |
No |
- |
- |
llmSelection |
AgentLlmConfigRoutingLlmCustomizationLlmSelection defines nested fields for Agent.LlmConfig.RoutingLlmCustomization.LlmSelection. |
object |
No |
- |
- |
Spec.llmConfig.routingLlmCustomization.llmSelection
Back to Agent spec
AgentLlmConfigRoutingLlmCustomizationLlmSelection defines nested fields for Agent.LlmConfig.RoutingLlmCustomization.LlmSelection.
| Field |
Description |
Type |
Required |
Default |
Enum |
endpointId |
The OCID of the GenAI endpoint |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
llmSelectionType |
- |
string |
No |
- |
- |
modelId |
The OCID of the GenAI model |
string |
No |
- |
- |
Status
AgentStatus defines the observed state of Agent.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
Description about the agent. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent. |
string |
No |
- |
- |
knowledgeBaseIds |
List of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. |
list[string] |
No |
- |
- |
lifecycleDetails |
A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state. |
string |
No |
- |
- |
lifecycleState |
The current state of the agent. |
string |
No |
- |
- |
llmConfig |
AgentLlmConfig defines nested fields for Agent.LlmConfig. |
object |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The date and time the agent was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
timeUpdated |
The date and time the agent was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
welcomeMessage |
Details about purpose and responsibility of the agent |
string |
No |
- |
- |
Status.llmConfig
Back to Agent status
AgentLlmConfig defines nested fields for Agent.LlmConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
routingLlmCustomization |
AgentLlmConfigRoutingLlmCustomization defines nested fields for Agent.LlmConfig.RoutingLlmCustomization. |
object |
No |
- |
- |
runtimeVersion |
The runtimeVersion of the system prompt. |
string |
No |
- |
- |
Status.llmConfig.routingLlmCustomization
Back to Agent status
AgentLlmConfigRoutingLlmCustomization defines nested fields for Agent.LlmConfig.RoutingLlmCustomization.
| Field |
Description |
Type |
Required |
Default |
Enum |
instruction |
If specified, the default instruction is replaced with provided instruction. |
string |
No |
- |
- |
llmHyperParameters |
Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. |
map[string, object (preserves unknown fields)] |
No |
- |
- |
llmSelection |
AgentLlmConfigRoutingLlmCustomizationLlmSelection defines nested fields for Agent.LlmConfig.RoutingLlmCustomization.LlmSelection. |
object |
No |
- |
- |
Status.llmConfig.routingLlmCustomization.llmSelection
Back to Agent status
AgentLlmConfigRoutingLlmCustomizationLlmSelection defines nested fields for Agent.LlmConfig.RoutingLlmCustomization.LlmSelection.
| Field |
Description |
Type |
Required |
Default |
Enum |
endpointId |
The OCID of the GenAI endpoint |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
llmSelectionType |
- |
string |
No |
- |
- |
modelId |
The OCID of the GenAI model |
string |
No |
- |
- |
Status.status
Back to Agent status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Agent status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Agent status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Agent status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
AgentEndpoint
Manage OCI Generative AI Agent endpoints.
Plural: agentendpointsScope: NamespacedAPIVersion: generativeaiagent.oracle.com/v1beta1Sample: Sample (config/samples/generativeaiagent_v1beta1_agentendpoint.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
AgentEndpointSpec defines the desired state of AgentEndpoint.
| Field |
Description |
Type |
Required |
Default |
Enum |
agentId |
The OCID of the agent that this endpoint is associated with. |
string |
Yes |
- |
- |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the endpoint in. |
string |
Yes |
- |
- |
contentModerationConfig |
AgentEndpointContentModerationConfig defines nested fields for AgentEndpoint.ContentModerationConfig. |
object |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
An optional description of the endpoint. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
guardrailConfig |
AgentEndpointGuardrailConfig defines nested fields for AgentEndpoint.GuardrailConfig. |
object |
No |
- |
- |
humanInputConfig |
AgentEndpointHumanInputConfig defines nested fields for AgentEndpoint.HumanInputConfig. |
object |
No |
- |
- |
metadata |
Key-value pairs to allow additional configurations. |
map[string, string] |
No |
- |
- |
outputConfig |
AgentEndpointOutputConfig defines nested fields for AgentEndpoint.OutputConfig. |
object |
No |
- |
- |
provisionedCapacityConfig |
AgentEndpointProvisionedCapacityConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig. |
object |
No |
- |
- |
sessionConfig |
AgentEndpointSessionConfig defines nested fields for AgentEndpoint.SessionConfig. |
object |
No |
- |
- |
shouldEnableCitation |
Whether to show citations in the chat result. |
boolean |
No |
- |
- |
shouldEnableMultiLanguage |
Whether to enable multi-language for chat. |
boolean |
No |
- |
- |
shouldEnableSession |
Whether or not to enable Session-based chat. |
boolean |
No |
- |
- |
shouldEnableTrace |
Whether to show traces in the chat result. |
boolean |
No |
- |
- |
Spec.contentModerationConfig
Back to AgentEndpoint spec
AgentEndpointContentModerationConfig defines nested fields for AgentEndpoint.ContentModerationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
shouldEnableOnInput |
A flag to enable or disable content moderation on input. |
boolean |
No |
- |
- |
shouldEnableOnOutput |
A flag to enable or disable content moderation on output. |
boolean |
No |
- |
- |
Spec.guardrailConfig
Back to AgentEndpoint spec
AgentEndpointGuardrailConfig defines nested fields for AgentEndpoint.GuardrailConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
contentModerationConfig |
AgentEndpointGuardrailConfigContentModerationConfig defines nested fields for AgentEndpoint.GuardrailConfig.ContentModerationConfig. |
object |
No |
- |
- |
personallyIdentifiableInformationConfig |
AgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig defines nested fields for AgentEndpoint.GuardrailConfig.PersonallyIdentifiableInformationConfig. |
object |
No |
- |
- |
promptInjectionConfig |
AgentEndpointGuardrailConfigPromptInjectionConfig defines nested fields for AgentEndpoint.GuardrailConfig.PromptInjectionConfig. |
object |
No |
- |
- |
Spec.guardrailConfig.contentModerationConfig
Back to AgentEndpoint spec
AgentEndpointGuardrailConfigContentModerationConfig defines nested fields for AgentEndpoint.GuardrailConfig.ContentModerationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
inputGuardrailMode |
An input guardrail mode for content moderation. |
string |
No |
- |
- |
outputGuardrailMode |
An output guardrail mode for content moderation. |
string |
No |
- |
- |
Back to AgentEndpoint spec
AgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig defines nested fields for AgentEndpoint.GuardrailConfig.PersonallyIdentifiableInformationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
inputGuardrailMode |
An input guardrail mode for personally identifiable information. |
string |
No |
- |
- |
outputGuardrailMode |
An output guardrail mode for personally identifiable information. |
string |
No |
- |
- |
Spec.guardrailConfig.promptInjectionConfig
Back to AgentEndpoint spec
AgentEndpointGuardrailConfigPromptInjectionConfig defines nested fields for AgentEndpoint.GuardrailConfig.PromptInjectionConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
inputGuardrailMode |
An input guardrail mode for prompt injection. |
string |
No |
- |
- |
Back to AgentEndpoint spec
AgentEndpointHumanInputConfig defines nested fields for AgentEndpoint.HumanInputConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
shouldEnableHumanInput |
The Agent will request for human input for disambiguation or additional information gathering if this is enabled. |
boolean |
Yes |
- |
- |
Spec.outputConfig
Back to AgentEndpoint spec
AgentEndpointOutputConfig defines nested fields for AgentEndpoint.OutputConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
outputLocation |
AgentEndpointOutputConfigOutputLocation defines nested fields for AgentEndpoint.OutputConfig.OutputLocation. |
object |
Yes |
- |
- |
retentionPeriodInMinutes |
Retention duration of the output data. |
integer |
No |
- |
- |
Spec.outputConfig.outputLocation
Back to AgentEndpoint spec
AgentEndpointOutputConfigOutputLocation defines nested fields for AgentEndpoint.OutputConfig.OutputLocation.
| Field |
Description |
Type |
Required |
Default |
Enum |
bucketName |
The name of the bucket. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
namespaceName |
The namespace of the object storage. |
string |
No |
- |
- |
outputLocationType |
- |
string |
No |
- |
- |
prefix |
The prefix of the object storage. |
string |
No |
- |
- |
Spec.provisionedCapacityConfig
Back to AgentEndpoint spec
AgentEndpointProvisionedCapacityConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
platformRuntimeConfig |
AgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.PlatformRuntimeConfig. |
object |
No |
- |
- |
provisionedCapacityId |
An OCID that uniquely identifies an Provisioned Capacity. |
string |
Yes |
- |
- |
toolRuntimeConfigs |
RAG and SQL will be tools. |
list[object] |
No |
- |
- |
Back to AgentEndpoint spec
AgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.PlatformRuntimeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
platformRuntimeConfigType |
The type of Platform runtime config. |
string |
No |
- |
- |
version |
The version of the Core. The latest version will be displayed as default. |
string |
No |
- |
- |
Back to AgentEndpoint spec
AgentEndpointProvisionedCapacityConfigToolRuntimeConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.ToolRuntimeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
toolRuntimeConfigType |
The type of the tool. |
string |
Yes |
- |
- |
version |
The version of the components. |
string |
No |
- |
- |
Spec.sessionConfig
Back to AgentEndpoint spec
AgentEndpointSessionConfig defines nested fields for AgentEndpoint.SessionConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
idleTimeoutInSeconds |
The session will become inactive after this timeout. |
integer |
No |
- |
- |
Status
AgentEndpointStatus defines the observed state of AgentEndpoint.
| Field |
Description |
Type |
Required |
Default |
Enum |
agentId |
The OCID of the agent that this endpoint is associated with. |
string |
No |
- |
- |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
string |
No |
- |
- |
contentModerationConfig |
AgentEndpointContentModerationConfig defines nested fields for AgentEndpoint.ContentModerationConfig. |
object |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
An optional description of the endpoint. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
guardrailConfig |
AgentEndpointGuardrailConfig defines nested fields for AgentEndpoint.GuardrailConfig. |
object |
No |
- |
- |
humanInputConfig |
AgentEndpointHumanInputConfig defines nested fields for AgentEndpoint.HumanInputConfig. |
object |
No |
- |
- |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. |
string |
No |
- |
- |
lifecycleDetails |
A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state. |
string |
No |
- |
- |
lifecycleState |
The current state of the endpoint. |
string |
No |
- |
- |
metadata |
Key-value pairs to allow additional configurations. |
map[string, string] |
No |
- |
- |
outputConfig |
AgentEndpointOutputConfig defines nested fields for AgentEndpoint.OutputConfig. |
object |
No |
- |
- |
provisionedCapacityConfig |
AgentEndpointProvisionedCapacityConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig. |
object |
No |
- |
- |
sessionConfig |
AgentEndpointSessionConfig defines nested fields for AgentEndpoint.SessionConfig. |
object |
No |
- |
- |
shouldEnableCitation |
Whether to show citations in the chat result. |
boolean |
No |
- |
- |
shouldEnableMultiLanguage |
Whether to enable multi-language for chat. |
boolean |
No |
- |
- |
shouldEnableSession |
Whether or not to enable Session-based chat. |
boolean |
No |
- |
- |
shouldEnableTrace |
Whether to show traces in the chat result. |
boolean |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The date and time the AgentEndpoint was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
timeUpdated |
The date and time the endpoint was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
Status.contentModerationConfig
Back to AgentEndpoint status
AgentEndpointContentModerationConfig defines nested fields for AgentEndpoint.ContentModerationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
shouldEnableOnInput |
A flag to enable or disable content moderation on input. |
boolean |
No |
- |
- |
shouldEnableOnOutput |
A flag to enable or disable content moderation on output. |
boolean |
No |
- |
- |
Status.guardrailConfig
Back to AgentEndpoint status
AgentEndpointGuardrailConfig defines nested fields for AgentEndpoint.GuardrailConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
contentModerationConfig |
AgentEndpointGuardrailConfigContentModerationConfig defines nested fields for AgentEndpoint.GuardrailConfig.ContentModerationConfig. |
object |
No |
- |
- |
personallyIdentifiableInformationConfig |
AgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig defines nested fields for AgentEndpoint.GuardrailConfig.PersonallyIdentifiableInformationConfig. |
object |
No |
- |
- |
promptInjectionConfig |
AgentEndpointGuardrailConfigPromptInjectionConfig defines nested fields for AgentEndpoint.GuardrailConfig.PromptInjectionConfig. |
object |
No |
- |
- |
Status.guardrailConfig.contentModerationConfig
Back to AgentEndpoint status
AgentEndpointGuardrailConfigContentModerationConfig defines nested fields for AgentEndpoint.GuardrailConfig.ContentModerationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
inputGuardrailMode |
An input guardrail mode for content moderation. |
string |
No |
- |
- |
outputGuardrailMode |
An output guardrail mode for content moderation. |
string |
No |
- |
- |
Back to AgentEndpoint status
AgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig defines nested fields for AgentEndpoint.GuardrailConfig.PersonallyIdentifiableInformationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
inputGuardrailMode |
An input guardrail mode for personally identifiable information. |
string |
No |
- |
- |
outputGuardrailMode |
An output guardrail mode for personally identifiable information. |
string |
No |
- |
- |
Status.guardrailConfig.promptInjectionConfig
Back to AgentEndpoint status
AgentEndpointGuardrailConfigPromptInjectionConfig defines nested fields for AgentEndpoint.GuardrailConfig.PromptInjectionConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
inputGuardrailMode |
An input guardrail mode for prompt injection. |
string |
No |
- |
- |
Back to AgentEndpoint status
AgentEndpointHumanInputConfig defines nested fields for AgentEndpoint.HumanInputConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
shouldEnableHumanInput |
The Agent will request for human input for disambiguation or additional information gathering if this is enabled. |
boolean |
Yes |
- |
- |
Status.outputConfig
Back to AgentEndpoint status
AgentEndpointOutputConfig defines nested fields for AgentEndpoint.OutputConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
outputLocation |
AgentEndpointOutputConfigOutputLocation defines nested fields for AgentEndpoint.OutputConfig.OutputLocation. |
object |
Yes |
- |
- |
retentionPeriodInMinutes |
Retention duration of the output data. |
integer |
No |
- |
- |
Status.outputConfig.outputLocation
Back to AgentEndpoint status
AgentEndpointOutputConfigOutputLocation defines nested fields for AgentEndpoint.OutputConfig.OutputLocation.
| Field |
Description |
Type |
Required |
Default |
Enum |
bucketName |
The name of the bucket. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
namespaceName |
The namespace of the object storage. |
string |
No |
- |
- |
outputLocationType |
- |
string |
No |
- |
- |
prefix |
The prefix of the object storage. |
string |
No |
- |
- |
Status.provisionedCapacityConfig
Back to AgentEndpoint status
AgentEndpointProvisionedCapacityConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
platformRuntimeConfig |
AgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.PlatformRuntimeConfig. |
object |
No |
- |
- |
provisionedCapacityId |
An OCID that uniquely identifies an Provisioned Capacity. |
string |
Yes |
- |
- |
toolRuntimeConfigs |
RAG and SQL will be tools. |
list[object] |
No |
- |
- |
Back to AgentEndpoint status
AgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.PlatformRuntimeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
platformRuntimeConfigType |
The type of Platform runtime config. |
string |
No |
- |
- |
version |
The version of the Core. The latest version will be displayed as default. |
string |
No |
- |
- |
Back to AgentEndpoint status
AgentEndpointProvisionedCapacityConfigToolRuntimeConfig defines nested fields for AgentEndpoint.ProvisionedCapacityConfig.ToolRuntimeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
toolRuntimeConfigType |
The type of the tool. |
string |
Yes |
- |
- |
version |
The version of the components. |
string |
No |
- |
- |
Status.sessionConfig
Back to AgentEndpoint status
AgentEndpointSessionConfig defines nested fields for AgentEndpoint.SessionConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
idleTimeoutInSeconds |
The session will become inactive after this timeout. |
integer |
No |
- |
- |
Status.status
Back to AgentEndpoint status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to AgentEndpoint status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to AgentEndpoint status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to AgentEndpoint status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
DataSource
Manage OCI Generative AI Agent data sources.
Plural: datasourcesScope: NamespacedAPIVersion: generativeaiagent.oracle.com/v1beta1Sample: Sample (config/samples/generativeaiagent_v1beta1_datasource.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
DataSourceSpec defines the desired state of DataSource.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the data source in. |
string |
Yes |
- |
- |
dataSourceConfig |
DataSourceConfig defines nested fields for DataSource.DataSourceConfig. |
object |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
A description of the data source. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
knowledgeBaseId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase. |
string |
Yes |
- |
- |
metadata |
Key-value pairs to allow additional configurations. |
map[string, string] |
No |
- |
- |
Spec.dataSourceConfig
Back to DataSource spec
DataSourceConfig defines nested fields for DataSource.DataSourceConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
dataSourceConfigType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
objectStoragePrefixes |
The locations of data items in Object Storage, can either be an object (File) or a prefix (folder). |
list[object] |
No |
- |
- |
shouldEnableMultiModality |
Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion. |
boolean |
No |
- |
- |
Spec.dataSourceConfig.objectStoragePrefixes[]
Back to DataSource spec
DataSourceConfigObjectStoragePrefix defines nested fields for DataSource.DataSourceConfig.ObjectStoragePrefix.
| Field |
Description |
Type |
Required |
Default |
Enum |
bucketName |
The bucket name of an object. |
string |
Yes |
- |
- |
namespaceName |
The namespace name of an object. |
string |
Yes |
- |
- |
prefix |
The prefix of file object(s) or folder prefix. |
string |
No |
- |
- |
Status
DataSourceStatus defines the observed state of DataSource.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
string |
No |
- |
- |
dataSourceConfig |
DataSourceConfig defines nested fields for DataSource.DataSourceConfig. |
object |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
A description of the data source. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source. |
string |
No |
- |
- |
knowledgeBaseId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase. |
string |
No |
- |
- |
lifecycleDetails |
A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state. |
string |
No |
- |
- |
lifecycleState |
The current state of the data source. |
string |
No |
- |
- |
metadata |
Key-value pairs to allow additional configurations. |
map[string, string] |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The date and time the data source was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
timeUpdated |
The date and time the data source was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
Status.dataSourceConfig
Back to DataSource status
DataSourceConfig defines nested fields for DataSource.DataSourceConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
dataSourceConfigType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
objectStoragePrefixes |
The locations of data items in Object Storage, can either be an object (File) or a prefix (folder). |
list[object] |
No |
- |
- |
shouldEnableMultiModality |
Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion. |
boolean |
No |
- |
- |
Status.dataSourceConfig.objectStoragePrefixes[]
Back to DataSource status
DataSourceConfigObjectStoragePrefix defines nested fields for DataSource.DataSourceConfig.ObjectStoragePrefix.
| Field |
Description |
Type |
Required |
Default |
Enum |
bucketName |
The bucket name of an object. |
string |
Yes |
- |
- |
namespaceName |
The namespace name of an object. |
string |
Yes |
- |
- |
prefix |
The prefix of file object(s) or folder prefix. |
string |
No |
- |
- |
Status.status
Back to DataSource status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to DataSource status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to DataSource status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to DataSource status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
KnowledgeBase
Manage OCI Generative AI Agent knowledge bases.
Plural: knowledgebasesScope: NamespacedAPIVersion: generativeaiagent.oracle.com/v1beta1Sample: Sample (config/samples/generativeaiagent_v1beta1_knowledgebase.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
KnowledgeBaseSpec defines the desired state of KnowledgeBase.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the knowledge base in. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
A user-friendly description of the knowledge base. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
indexConfig |
KnowledgeBaseIndexConfig defines nested fields for KnowledgeBase.IndexConfig. |
object |
Yes |
- |
- |
Spec.indexConfig
Back to KnowledgeBase spec
KnowledgeBaseIndexConfig defines nested fields for KnowledgeBase.IndexConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster. |
string |
No |
- |
- |
databaseConnection |
KnowledgeBaseIndexConfigDatabaseConnection defines nested fields for KnowledgeBase.IndexConfig.DatabaseConnection. |
object |
No |
- |
- |
databaseFunctions |
Array of Database functions to be used. |
list[object] |
No |
- |
- |
indexConfigType |
- |
string |
No |
- |
- |
indexes |
Index configuration for open search. |
list[object] |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
secretDetail |
KnowledgeBaseIndexConfigSecretDetail defines nested fields for KnowledgeBase.IndexConfig.SecretDetail. |
object |
No |
- |
- |
shouldEnableHybridSearch |
Whether to enable Hybrid search in service managed OpenSearch. |
boolean |
No |
- |
- |
Spec.indexConfig.databaseConnection
Back to KnowledgeBase spec
KnowledgeBaseIndexConfigDatabaseConnection defines nested fields for KnowledgeBase.IndexConfig.DatabaseConnection.
| Field |
Description |
Type |
Required |
Default |
Enum |
connectionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. |
string |
No |
- |
- |
connectionType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
Spec.indexConfig.databaseFunctions[]
Back to KnowledgeBase spec
KnowledgeBaseIndexConfigDatabaseFunction defines nested fields for KnowledgeBase.IndexConfig.DatabaseFunction.
| Field |
Description |
Type |
Required |
Default |
Enum |
name |
The name of the Database function. |
string |
Yes |
- |
- |
Spec.indexConfig.indexes[]
Back to KnowledgeBase spec
KnowledgeBaseIndexConfigIndex defines nested fields for KnowledgeBase.IndexConfig.Index.
| Field |
Description |
Type |
Required |
Default |
Enum |
name |
The index name in opensearch. |
string |
Yes |
- |
- |
schema |
KnowledgeBaseIndexConfigIndexSchema defines nested fields for KnowledgeBase.IndexConfig.Index.Schema. |
object |
Yes |
- |
- |
Spec.indexConfig.indexes[].schema
Back to KnowledgeBase spec
KnowledgeBaseIndexConfigIndexSchema defines nested fields for KnowledgeBase.IndexConfig.Index.Schema.
| Field |
Description |
Type |
Required |
Default |
Enum |
bodyKey |
Body key name. |
string |
Yes |
- |
- |
embeddingBodyKey |
Field within customer managed OCI OpenSearch document containing the vector embedding for queries. |
string |
No |
- |
- |
titleKey |
Title key that stores the Title of a document, if available. |
string |
No |
- |
- |
urlKey |
URL key that stores the URL of a document, if available. |
string |
No |
- |
- |
Spec.indexConfig.secretDetail
Back to KnowledgeBase spec
KnowledgeBaseIndexConfigSecretDetail defines nested fields for KnowledgeBase.IndexConfig.SecretDetail.
| Field |
Description |
Type |
Required |
Default |
Enum |
clientId |
The IDCS Connect clientId. |
string |
No |
- |
- |
idcsUrl |
The URL represent authentication url of the IDCS. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
scopeUrl |
Fully qualified scope url |
string |
No |
- |
- |
type |
- |
string |
No |
- |
- |
vaultSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for client secret. |
string |
No |
- |
- |
Status
KnowledgeBaseStatus defines the observed state of KnowledgeBase.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
A description of the knowledge base. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. |
string |
No |
- |
- |
indexConfig |
KnowledgeBaseIndexConfig defines nested fields for KnowledgeBase.IndexConfig. |
object |
No |
- |
- |
knowledgeBaseStatistics |
KnowledgeBaseStatistics defines nested fields for KnowledgeBase.KnowledgeBaseStatistics. |
object |
No |
- |
- |
lifecycleDetails |
A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state. |
string |
No |
- |
- |
lifecycleState |
The current state of the knowledge base. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The date and time the knowledge base was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
timeUpdated |
The date and time the knowledge base was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
- |
- |
Status.indexConfig
Back to KnowledgeBase status
KnowledgeBaseIndexConfig defines nested fields for KnowledgeBase.IndexConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster. |
string |
No |
- |
- |
databaseConnection |
KnowledgeBaseIndexConfigDatabaseConnection defines nested fields for KnowledgeBase.IndexConfig.DatabaseConnection. |
object |
No |
- |
- |
databaseFunctions |
Array of Database functions to be used. |
list[object] |
No |
- |
- |
indexConfigType |
- |
string |
No |
- |
- |
indexes |
Index configuration for open search. |
list[object] |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
secretDetail |
KnowledgeBaseIndexConfigSecretDetail defines nested fields for KnowledgeBase.IndexConfig.SecretDetail. |
object |
No |
- |
- |
shouldEnableHybridSearch |
Whether to enable Hybrid search in service managed OpenSearch. |
boolean |
No |
- |
- |
Status.indexConfig.databaseConnection
Back to KnowledgeBase status
KnowledgeBaseIndexConfigDatabaseConnection defines nested fields for KnowledgeBase.IndexConfig.DatabaseConnection.
| Field |
Description |
Type |
Required |
Default |
Enum |
connectionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. |
string |
No |
- |
- |
connectionType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
Status.indexConfig.databaseFunctions[]
Back to KnowledgeBase status
KnowledgeBaseIndexConfigDatabaseFunction defines nested fields for KnowledgeBase.IndexConfig.DatabaseFunction.
| Field |
Description |
Type |
Required |
Default |
Enum |
name |
The name of the Database function. |
string |
Yes |
- |
- |
Status.indexConfig.indexes[]
Back to KnowledgeBase status
KnowledgeBaseIndexConfigIndex defines nested fields for KnowledgeBase.IndexConfig.Index.
| Field |
Description |
Type |
Required |
Default |
Enum |
name |
The index name in opensearch. |
string |
Yes |
- |
- |
schema |
KnowledgeBaseIndexConfigIndexSchema defines nested fields for KnowledgeBase.IndexConfig.Index.Schema. |
object |
Yes |
- |
- |
Status.indexConfig.indexes[].schema
Back to KnowledgeBase status
KnowledgeBaseIndexConfigIndexSchema defines nested fields for KnowledgeBase.IndexConfig.Index.Schema.
| Field |
Description |
Type |
Required |
Default |
Enum |
bodyKey |
Body key name. |
string |
Yes |
- |
- |
embeddingBodyKey |
Field within customer managed OCI OpenSearch document containing the vector embedding for queries. |
string |
No |
- |
- |
titleKey |
Title key that stores the Title of a document, if available. |
string |
No |
- |
- |
urlKey |
URL key that stores the URL of a document, if available. |
string |
No |
- |
- |
Status.indexConfig.secretDetail
Back to KnowledgeBase status
KnowledgeBaseIndexConfigSecretDetail defines nested fields for KnowledgeBase.IndexConfig.SecretDetail.
| Field |
Description |
Type |
Required |
Default |
Enum |
clientId |
The IDCS Connect clientId. |
string |
No |
- |
- |
idcsUrl |
The URL represent authentication url of the IDCS. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
scopeUrl |
Fully qualified scope url |
string |
No |
- |
- |
type |
- |
string |
No |
- |
- |
vaultSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for client secret. |
string |
No |
- |
- |
Status.knowledgeBaseStatistics
Back to KnowledgeBase status
KnowledgeBaseStatistics defines nested fields for KnowledgeBase.KnowledgeBaseStatistics.
| Field |
Description |
Type |
Required |
Default |
Enum |
sizeInBytes |
Knowledge Base size in bytes. |
integer (int64) |
No |
- |
- |
totalIngestedFiles |
Total number of ingested files in Knowledge Base. |
integer (int64) |
No |
- |
- |
Status.status
Back to KnowledgeBase status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to KnowledgeBase status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to KnowledgeBase status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to KnowledgeBase status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |