Show / Hide Table of Contents

Namespace Oci.GenerativeaidataService.Models

Classes

DatabaseObject

The type of database object

DeltaRefreshEnrichmentJobConfiguration

A DeltaRefreshEnrichmentJobConfiguration is an EnrichmentJobConfiguration [indicated by the first item under allOf, which is a reference to EnrichmentJobConfiguration] that describes the database schema that will be the scope of the delta refresh enrichment job. As distinguished by enrichmentJobType [with specific characteristics defined by the second item under allOf]. deltaRefreshSchedule is optional, is not used by the service, and is retained only for backward compatibility. It should be treated as deprecated.

EnrichmentJob

Object representing to EnrichmentJob. ocidEntityType: generativeaisemanticstorejob adLocality: regional

EnrichmentJobCollection

Object representing list of EnrichmentJobSummaries.

EnrichmentJobConfiguration

An EnrichmentJobConfiguration describes the database objects that will be targeted by an EnrichmentJob, as described by the job's type.

EnrichmentJobConfigurationModelConverter

EnrichmentJobSummary

Object representing EnrichmentJobSummary resource.

FullBuildEnrichmentJobConfiguration

A FullBuildEnrichmentJobConfiguration is an EnrichmentJobConfiguration [indicated by the first item under allOf, which is a reference to EnrichmentJobConfiguration] that describes the database schema that will be the scope of the enrichment job. As distinguished by enrichmentJobType [with specific characteristics defined by the second item under allOf].

GenerateEnrichmentJobDetails

The details required to create an EnrichmentJob.

GenerateSqlFromNlDetails

The data to create a GenerateSqlFromNlJob.

GenerateSqlFromNlJob

Object representing to GenerateSqlFromNlJob. ocidEntityType: generativeaisemanticstorejob adLocality: regional

InlineJobOutput

An InlineJobOutput is a JobOutput [indicated by the first item under allOf, which is a reference to JobOutput] that delivers results of the GenerateSQLJob in the body of the job itself. As distinguished by jobOutputLocation [with specific characteristics defined by the second item under allOf].

JobOutput

A JobOutput delivers content generated by the GenerateSQLJob to a given location, which corresponds with type-specific characteristics. This field is present on GenerateSqlFromNlJob only when lifecycleState is SUCCEEDED. It is omitted for all other lifecycle states.

JobOutputModelConverter

PartialBuildEnrichmentJobConfiguration

A PartialBuildEnrichmentJobConfiguration is an EnrichmentJobConfiguration [indicated by the first item under allOf, which is a reference to EnrichmentJobConfiguration] that describes the database schema that will be the scope of the enrichment job. As distinguished by enrichmentJobType [with specific characteristics defined by the second item under allOf].

Enums

CompletionMode

Controls whether GenerateSqlFromNl, ExecuteSql, or Query waits for execution to finish or submits background execution.

DatabaseObject.TypeEnum

EnrichmentJobType

Enrichment job type. Supported values are Full Build (all supported objects in a given schema), Partial Build (selected tables and/or supported objects in a given schema), and Delta Refresh (objects in a given schema that have changed since the previous enrichment job).

JobOutputLocation

Enumerated location type for job output.

LifecycleState

Possible lifecycle states.

SortOrders

Sort orders.

In this article
Back to top