Package com.oracle.bmc.generativeaidata

Interface GenerateSql

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    GenerateSqlClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20260325")
public interface GenerateSql
extends AutoCloseable
    A description of the ReferenceService API.

    in progress This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • generateSqlFromNl

        GenerateSqlFromNlResponse generateSqlFromNl​(GenerateSqlFromNlRequest request)
        Generates a SQL query from a natural language input for the specified SemanticStore.

        This operation creates a GenerateSqlFromNlJob. The request can either be processed as a background job or wait for completion, depending on completionMode.

        If modelId is provided, the service validates it and uses it for schema-linking in table selection, SQL generation, and SQL refinement. If modelId is omitted, the service default model is used. The response includes the modelId used for generation.

        Clients should inspect lifecycleState in the response: - If lifecycleState is SUCCEEDED, SQL generation is complete and the result is available in jobOutput. - If lifecycleState is ACCEPTED or IN_PROGRESS, poll GetGenerateSqlFromNlJob using the returned job id. - If lifecycleState is FAILED or CANCELED, SQL generation did not complete. See lifecycleDetails for more information.

        The GetGenerateSqlFromNlJob endpoint is the source of truth for final job state and result availability.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.95.0/generativeaidata/GenerateSqlFromNlExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GenerateSqlFromNl API.

      • getGenerateSqlFromNlJob

        GetGenerateSqlFromNlJobResponse getGenerateSqlFromNlJob​(GetGenerateSqlFromNlJobRequest request)
        Retrieves the current state of a GenerateSqlFromNlJob.

        Clients should poll this endpoint until lifecycleState is SUCCEEDED or FAILED. When lifecycleState is SUCCEEDED, the result is available in jobOutput. The returned job includes the modelId used for generation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.95.0/generativeaidata/GetGenerateSqlFromNlJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGenerateSqlFromNlJob API.

      • getWaiters

        GenerateSqlWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.