Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::DataFoundryService::Client (v1.21.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::DataFoundryService::Client.

Client for the DataFoundryService service.

Service for generating and preparing datasets for Gen AI evaluation.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DataFoundryService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all DataFoundryService clients
::Google::Cloud::AIPlatform::V1::DataFoundryService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the DataFoundryService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#generate_synthetic_data

def generate_synthetic_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::GenerateSyntheticDataResponse
def generate_synthetic_data(task_description: nil, location: nil, count: nil, output_field_specs: nil, examples: nil) -> ::Google::Cloud::AIPlatform::V1::GenerateSyntheticDataResponse

Generates synthetic data based on the provided configuration.

Overloads 
def generate_synthetic_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::GenerateSyntheticDataResponse
Pass arguments to generate_synthetic_data via a request object, either of type GenerateSyntheticDataRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GenerateSyntheticDataRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def generate_synthetic_data(task_description: nil, location: nil, count: nil, output_field_specs: nil, examples: nil) -> ::Google::Cloud::AIPlatform::V1::GenerateSyntheticDataResponse
Pass arguments to generate_synthetic_data via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::DataFoundryService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GenerateSyntheticDataRequest.new

# Call the generate_synthetic_data method.
result = client.generate_synthetic_data request

# The returned object is of type Google::Cloud::AIPlatform::V1::GenerateSyntheticDataResponse.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new DataFoundryService client object.

Yields
  • (config) — Configure the DataFoundryService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::DataFoundryService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::DataFoundryService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)