Uses of Package
com.oracle.bmc.generativeaiagent.model

Packages that use com.oracle.bmc.generativeaiagent.model

Package	Description
com.oracle.bmc.generativeaiagent
com.oracle.bmc.generativeaiagent.model
com.oracle.bmc.generativeaiagent.requests
com.oracle.bmc.generativeaiagent.responses

Classes in com.oracle.bmc.generativeaiagent.model used by com.oracle.bmc.generativeaiagent

Class and Description
Agent.LifecycleState The current state of the agent.
AgentEndpoint.LifecycleState The current state of the endpoint.
AgentEndpointSummary Summary information about an endpoint.
AgentSummary Summary information about an agent.
DataIngestionJob.LifecycleState The current state of the data ingestion job.
DataIngestionJobSummary Summary information about a data ingestion job.
DataSource.LifecycleState The current state of the data source.
DataSourceSummary Summary information about a data source.
KnowledgeBase.LifecycleState The current state of the knowledge base.
KnowledgeBaseSummary Summary information about a knowledge base.
Tool.LifecycleState The current state of the Tool.
ToolSummary Summary information of a Tool.
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
WorkRequestSummary Summary information about an asynchronous work request.

Classes in com.oracle.bmc.generativeaiagent.model used by com.oracle.bmc.generativeaiagent.model

Class and Description
ActionType Possible types of actions.
Agent An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions.
Agent.Builder
Agent.LifecycleState The current state of the agent.
AgentCollection Results of an agent search.
AgentCollection.Builder
AgentEndpoint The endpoint to access a deployed agent.
AgentEndpoint.Builder
AgentEndpoint.LifecycleState The current state of the endpoint.
AgentEndpointCollection Results of an agentEndpoint search.
AgentEndpointCollection.Builder
AgentEndpointSummary Summary information about an endpoint.
AgentEndpointSummary.Builder
AgentSummary Summary information about an agent.
AgentSummary.Builder
ApiSchemaInlineInputLocation The details of inline input of Api schema.
ApiSchemaInlineInputLocation.Builder
ApiSchemaInputLocation The input location definition for Api schema.
ApiSchemaInputLocation.ApiSchemaInputLocationType Type of Api Schema InputLocation.
ApiSchemaObjectStorageInputLocation The details of OCI Object Storage object location for Api schema.
ApiSchemaObjectStorageInputLocation.Builder
BasicAuthSecret The details of Basic authentication configured as in OpenSearch.
BasicAuthSecret.Builder
ChangeAgentCompartmentDetails The configuration details for the move operation.
ChangeAgentCompartmentDetails.Builder
ChangeAgentEndpointCompartmentDetails The configuration details for the move operation.
ChangeAgentEndpointCompartmentDetails.Builder
ChangeKnowledgeBaseCompartmentDetails The configuration details for the move operation.
ChangeKnowledgeBaseCompartmentDetails.Builder
ContentModerationConfig The configuration details about whether to apply the content moderation feature to input and output.
ContentModerationConfig.Builder
ContentModerationGuardrailConfig The configuration details about whether to apply the content moderation feature to input and output.
ContentModerationGuardrailConfig.Builder
CreateAgentDetails The data to create an agent.
CreateAgentDetails.Builder
CreateAgentEndpointDetails The data to create an endpoint.
CreateAgentEndpointDetails.Builder
CreateDataIngestionJobDetails The data to create a data ingestion job.
CreateDataIngestionJobDetails.Builder
CreateDataSourceDetails The data to create a data source.
CreateDataSourceDetails.Builder
CreateKnowledgeBaseDetails The data to create a knowledge base.
CreateKnowledgeBaseDetails.Builder
CreateToolDetails The data to create a Tool.
CreateToolDetails.Builder
DatabaseConnection The connection type for Databases.
DatabaseConnection.ConnectionType The type of Database connection.
DatabaseFunction The details of Database function.
DatabaseFunction.Builder
DatabaseToolConnection The details of the customer Database Tools Connection.
DatabaseToolConnection.Builder
DataIngestionJob When you create a data source, you specify the location of the data files.
DataIngestionJob.Builder
DataIngestionJob.LifecycleState The current state of the data ingestion job.
DataIngestionJobCollection Results of a data ingestion job search.
DataIngestionJobCollection.Builder
DataIngestionJobStatistics The statistics of data ingestion job.
DataIngestionJobStatistics.Builder
DataIngestionJobSummary Summary information about a data ingestion job.
DataIngestionJobSummary.Builder
DataSource A data source points to the source of your data.
DataSource.Builder
DataSource.LifecycleState The current state of the data source.
DataSourceCollection Results of a dataSource search.
DataSourceCollection.Builder
DataSourceConfig The details of data source.
DataSourceConfig.DataSourceConfigType The type of the tool.
DataSourceSummary Summary information about a data source.
DataSourceSummary.Builder
DefaultIndexConfig The default index is service managed vector store on behalf of the customer.
DefaultIndexConfig.Builder
Function Details of Function for Function calling tool.
Function.Builder
FunctionCallingToolConfig The configuration for Function calling Tool.
FunctionCallingToolConfig.Builder
GuardrailConfig The configuration details about whether to apply the guardrail checks to input and output.
GuardrailConfig.Builder
GuardrailMode Configuration setting applied to determine the guardrail mode for input or output.
HttpEndpointAuthConfig Auth related information to be used when invoking external endpoint Note: Objects should always be created or deserialized using the Builder.
HttpEndpointAuthConfig.HttpEndpointAuthConfigType The type of Auth config to be used when invoking an external endpoint.
HttpEndpointDelegatedBearerAuthConfig Specifies Bearer Token Authentication, where the same Bearer token received as part of the Agent Chat API request is used to invoke the external endpoint.
HttpEndpointDelegatedBearerAuthConfig.Builder
HttpEndpointIdcsAuthConfig Specifies authentication using Oracle Identity Cloud Service (IDCS), leveraging OAuth 2.0 for token-based authentication.
HttpEndpointIdcsAuthConfig.Builder
HttpEndpointNoAuthConfig Indicates that no authentication is required for invoking the endpoint.
HttpEndpointNoAuthConfig.Builder
HttpEndpointOciResourcePrincipalAuthConfig Specifies authentication using Oracle Cloud Infrastructure (OCI) Resource Principal, leveraging OCI’s identity-based authentication mechanism.
HttpEndpointOciResourcePrincipalAuthConfig.Builder
HttpEndpointToolConfig The configuration for HTTP endpoint Tool.
HttpEndpointToolConfig.Builder
HumanInputConfig Human Input Configuration for an AgentEndpoint.
HumanInputConfig.Builder
IdcsSecret The details of IDCS configured as OpenID setting in OpenSearch.
IdcsSecret.Builder
Index OCI OpenSearch index details.
Index.Builder
IndexConfig The index configuration of Knowledge bases.
IndexConfig.IndexConfigType The type of index.
IndexSchema The index schema details.
IndexSchema.Builder
InlineInputLocation The details of inline input location.
InlineInputLocation.Builder
InputLocation The input location definition.
InputLocation.InputLocationType Type of InputLocation.
KnowledgeBase A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses.
KnowledgeBase.Builder
KnowledgeBase.LifecycleState The current state of the knowledge base.
KnowledgeBaseCollection Results of a knowledge base search.
KnowledgeBaseCollection.Builder
KnowledgeBaseConfig The KnowledgeBase configuration this RAG Tool uses.
KnowledgeBaseConfig.Builder
KnowledgeBaseStatistics Statistics for Default Knowledge Base.
KnowledgeBaseStatistics.Builder
KnowledgeBaseSummary Summary information about a knowledge base.
KnowledgeBaseSummary.Builder
LlmConfig Configuration to Agent LLM.
LlmConfig.Builder
LlmCustomization Configuration to customize LLM.
LlmCustomization.Builder
ObjectStorageInputLocation The details of OCI Object Storage object.
ObjectStorageInputLocation.Builder
ObjectStoragePrefix The details of OCI Object Storage object.
ObjectStoragePrefix.Builder
ObjectStoragePrefixOutputLocation The config of object storage.
ObjectStoragePrefixOutputLocation.Builder
OciDatabaseConfig The details of the customer Database Connection.
OciDatabaseConfig.Builder
OciObjectStorageDataSourceConfig The details of OCI Search with OpenSearch data source information.
OciObjectStorageDataSourceConfig.Builder
OciOpenSearchIndexConfig The details of customer managed OCI OpenSearch.
OciOpenSearchIndexConfig.Builder
OperationStatus The status of the work request.
OperationType The asynchronous operation tracked by the work request.
OutputConfig Configuration to store results generated by agent.
OutputConfig.Builder
OutputLocation Location of the output.
OutputLocation.OutputLocationType Type of OutputLocation.
PersonallyIdentifiableInformationGuardrailConfig The configuration details for Personally Identifiable Information.
PersonallyIdentifiableInformationGuardrailConfig.Builder
PromptInjectionGuardrailConfig The configuration details for Prompt Injection.
PromptInjectionGuardrailConfig.Builder
RagToolConfig The configuration for RAG Tool.
RagToolConfig.Builder
SecretDetail The details of configured security configuration on OpenSearch.
SecretDetail.Type The type of OpenID.
SessionConfig Session Configuration on AgentEndpoint.
SessionConfig.Builder
SortOrder The sort order to use, either ascending (ASC) or descending (DESC).
SqlToolConfig The configuration for SQL Tool.
SqlToolConfig.Builder
SqlToolConfig.Dialect Dialect to be used for SQL generation.
SqlToolConfig.ModelSize Size of the model.
Tool The description of Tool.
Tool.Builder
Tool.LifecycleState The current state of the Tool.
ToolCollection Results of a Tool search.
ToolCollection.Builder
ToolConfig The configuration and type of Tool.
ToolConfig.ToolConfigType The type of the Tool config.
ToolSummary Summary information of a Tool.
ToolSummary.Builder
UpdateAgentDetails The data to update an agent.
UpdateAgentDetails.Builder
UpdateAgentEndpointDetails The data to update an endpoint.
UpdateAgentEndpointDetails.Builder
UpdateDataSourceDetails The data to update a data source.
UpdateDataSourceDetails.Builder
UpdateKnowledgeBaseDetails The data to update a knowledge base.
UpdateKnowledgeBaseDetails.Builder
UpdateToolDetails The data to update a Tool.
UpdateToolDetails.Builder
WorkRequest An asynchronous work request.
WorkRequest.Builder
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
WorkRequestError.Builder
WorkRequestErrorCollection A list of work request errors.
WorkRequestErrorCollection.Builder
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
WorkRequestLogEntry.Builder
WorkRequestLogEntryCollection A list of work request logs.
WorkRequestLogEntryCollection.Builder
WorkRequestResource A resource created or operated on by a work request.
WorkRequestResource.Builder
WorkRequestResourceMetadataKey Possible metadata keys for work request resource metadata.
WorkRequestSummary Summary information about an asynchronous work request.
WorkRequestSummary.Builder
WorkRequestSummaryCollection A list of work requests.
WorkRequestSummaryCollection.Builder

Classes in com.oracle.bmc.generativeaiagent.model used by com.oracle.bmc.generativeaiagent.requests

Class and Description
Agent.LifecycleState The current state of the agent.
AgentEndpoint.LifecycleState The current state of the endpoint.
ChangeAgentCompartmentDetails The configuration details for the move operation.
ChangeAgentEndpointCompartmentDetails The configuration details for the move operation.
ChangeKnowledgeBaseCompartmentDetails The configuration details for the move operation.
CreateAgentDetails The data to create an agent.
CreateAgentEndpointDetails The data to create an endpoint.
CreateDataIngestionJobDetails The data to create a data ingestion job.
CreateDataSourceDetails The data to create a data source.
CreateKnowledgeBaseDetails The data to create a knowledge base.
CreateToolDetails The data to create a Tool.
DataIngestionJob.LifecycleState The current state of the data ingestion job.
DataSource.LifecycleState The current state of the data source.
KnowledgeBase.LifecycleState The current state of the knowledge base.
OperationStatus The status of the work request.
SortOrder The sort order to use, either ascending (ASC) or descending (DESC).
Tool.LifecycleState The current state of the Tool.
UpdateAgentDetails The data to update an agent.
UpdateAgentEndpointDetails The data to update an endpoint.
UpdateDataSourceDetails The data to update a data source.
UpdateKnowledgeBaseDetails The data to update a knowledge base.
UpdateToolDetails The data to update a Tool.

Classes in com.oracle.bmc.generativeaiagent.model used by com.oracle.bmc.generativeaiagent.responses

Class and Description
Agent An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions.
AgentCollection Results of an agent search.
AgentEndpoint The endpoint to access a deployed agent.
AgentEndpointCollection Results of an agentEndpoint search.
DataIngestionJob When you create a data source, you specify the location of the data files.
DataIngestionJobCollection Results of a data ingestion job search.
DataSource A data source points to the source of your data.
DataSourceCollection Results of a dataSource search.
KnowledgeBase A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses.
KnowledgeBaseCollection Results of a knowledge base search.
Tool The description of Tool.
ToolCollection Results of a Tool search.
WorkRequest An asynchronous work request.
WorkRequestErrorCollection A list of work request errors.
WorkRequestLogEntryCollection A list of work request logs.
WorkRequestSummaryCollection A list of work requests.