Package com.oracle.bmc.generativeaidata.model

Class GenerateSqlFromNlDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • description

        public GenerateSqlFromNlDetails.Builder description​(String description)
        An optional description of the GenerateSqlFromNlJob.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • displayName

        public GenerateSqlFromNlDetails.Builder displayName​(String displayName)
        A user-friendly display name.

        It does not have to be unique and can be modified. Avoid entering confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • inputNaturalLanguageQuery

        public GenerateSqlFromNlDetails.Builder inputNaturalLanguageQuery​(String inputNaturalLanguageQuery)
        A user-provided query or instruction written in plain, conversational language.

        This input is intended to capture the user’s intent, question, or command without requiring technical syntax or structured formatting. The query should clearly express what the user wants to know or accomplish, allowing the system to interpret and respond appropriately.

        Parameters:
        inputNaturalLanguageQuery - the value to set
        Returns:
        this builder

      • modelId

        public GenerateSqlFromNlDetails.Builder modelId​(String modelId)
        The generative AI modelId to use for Generate SQL.

        You can use the ListModels API to list the available models. https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels

        Parameters:
        modelId - the value to set
        Returns:
        this builder

      • completionMode

        public GenerateSqlFromNlDetails.Builder completionMode​(CompletionMode completionMode)
        Controls whether GenerateSqlFromNl should be accepted as a background job or wait for completion.

        BACKGROUND_JOB accepts the request for background processing and returns a pollable job. WAIT_FOR_COMPLETION waits for completion within the service-defined timeout.

        Parameters:
        completionMode - the value to set
        Returns:
        this builder

      • freeformTags

        public GenerateSqlFromNlDetails.Builder freeformTags​(Map<String,​String> freeformTags)
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public GenerateSqlFromNlDetails.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder