Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::VertexRagDataService::Rest::Client (v0.59.0)

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

REST client for the VertexRagDataService service.

A service for managing user data for RAG.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the VertexRagDataService 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 VertexRagDataService clients
::Google::Cloud::AIPlatform::V1::VertexRagDataService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the VertexRagDataService 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

#create_rag_corpus

def create_rag_corpus(request, options = nil) -> ::Gapic::Operation
def create_rag_corpus(parent: nil, rag_corpus: nil) -> ::Gapic::Operation

Creates a RagCorpus.

Overloads 
def create_rag_corpus(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_rag_corpus via a request object, either of type CreateRagCorpusRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CreateRagCorpusRequest, ::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 create_rag_corpus(parent: nil, rag_corpus: nil) -> ::Gapic::Operation
Pass arguments to create_rag_corpus 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
  • parent (::String) — Required. The resource name of the Location to create the RagCorpus in. Format: projects/{project}/locations/{location}
  • rag_corpus (::Google::Cloud::AIPlatform::V1::RagCorpus, ::Hash) — Required. The RagCorpus to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_rag_corpus

def delete_rag_corpus(request, options = nil) -> ::Gapic::Operation
def delete_rag_corpus(name: nil, force: nil) -> ::Gapic::Operation

Deletes a RagCorpus.

Overloads 
def delete_rag_corpus(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_rag_corpus via a request object, either of type DeleteRagCorpusRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::DeleteRagCorpusRequest, ::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 delete_rag_corpus(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_rag_corpus 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
  • name (::String) — Required. The name of the RagCorpus resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
  • force (::Boolean) — Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_rag_file

def delete_rag_file(request, options = nil) -> ::Gapic::Operation
def delete_rag_file(name: nil) -> ::Gapic::Operation

Deletes a RagFile.

Overloads 
def delete_rag_file(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_rag_file via a request object, either of type DeleteRagFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::DeleteRagFileRequest, ::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 delete_rag_file(name: nil) -> ::Gapic::Operation
Pass arguments to delete_rag_file 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).
Parameter
  • name (::String) — Required. The name of the RagFile resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_rag_corpus

def get_rag_corpus(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::RagCorpus
def get_rag_corpus(name: nil) -> ::Google::Cloud::AIPlatform::V1::RagCorpus

Gets a RagCorpus.

Overloads 
def get_rag_corpus(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::RagCorpus
Pass arguments to get_rag_corpus via a request object, either of type GetRagCorpusRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetRagCorpusRequest, ::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 get_rag_corpus(name: nil) -> ::Google::Cloud::AIPlatform::V1::RagCorpus
Pass arguments to get_rag_corpus 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).
Parameter
  • name (::String) — Required. The name of the RagCorpus resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

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

#get_rag_file

def get_rag_file(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::RagFile
def get_rag_file(name: nil) -> ::Google::Cloud::AIPlatform::V1::RagFile

Gets a RagFile.

Overloads 
def get_rag_file(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::RagFile
Pass arguments to get_rag_file via a request object, either of type GetRagFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetRagFileRequest, ::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 get_rag_file(name: nil) -> ::Google::Cloud::AIPlatform::V1::RagFile
Pass arguments to get_rag_file 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).
Parameter
  • name (::String) — Required. The name of the RagFile resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

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

#iam_policy_client

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

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

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

#import_rag_files

def import_rag_files(request, options = nil) -> ::Gapic::Operation
def import_rag_files(parent: nil, import_rag_files_config: nil) -> ::Gapic::Operation

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Overloads 
def import_rag_files(request, options = nil) -> ::Gapic::Operation
Pass arguments to import_rag_files via a request object, either of type ImportRagFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ImportRagFilesRequest, ::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 import_rag_files(parent: nil, import_rag_files_config: nil) -> ::Gapic::Operation
Pass arguments to import_rag_files 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#initialize

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

Create a new VertexRagDataService REST client object.

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

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

#list_rag_corpora

def list_rag_corpora(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagCorpus>
def list_rag_corpora(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagCorpus>

Lists RagCorpora in a Location.

Overloads 
def list_rag_corpora(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagCorpus>
Pass arguments to list_rag_corpora via a request object, either of type ListRagCorporaRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ListRagCorporaRequest, ::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 list_rag_corpora(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagCorpus>
Pass arguments to list_rag_corpora 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
  • parent (::String) — Required. The resource name of the Location from which to list the RagCorpora. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The standard list page size.
  • page_token (::String) — Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::RagCorpus.
  p item
end

#list_rag_files

def list_rag_files(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagFile>
def list_rag_files(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagFile>

Lists RagFiles in a RagCorpus.

Overloads 
def list_rag_files(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagFile>
Pass arguments to list_rag_files via a request object, either of type ListRagFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ListRagFilesRequest, ::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 list_rag_files(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::RagFile>
Pass arguments to list_rag_files 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
  • parent (::String) — Required. The resource name of the RagCorpus from which to list the RagFiles. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
  • page_size (::Integer) — Optional. The standard list page size.
  • page_token (::String) — Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::RagFile.
  p item
end

#location_client

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

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

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

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::VertexRagDataService::Rest::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_rag_corpus

def update_rag_corpus(request, options = nil) -> ::Gapic::Operation
def update_rag_corpus(rag_corpus: nil) -> ::Gapic::Operation

Updates a RagCorpus.

Overloads 
def update_rag_corpus(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_rag_corpus via a request object, either of type UpdateRagCorpusRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::UpdateRagCorpusRequest, ::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 update_rag_corpus(rag_corpus: nil) -> ::Gapic::Operation
Pass arguments to update_rag_corpus 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).
Parameter
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#upload_rag_file

def upload_rag_file(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::UploadRagFileResponse
def upload_rag_file(parent: nil, rag_file: nil, upload_rag_file_config: nil) -> ::Google::Cloud::AIPlatform::V1::UploadRagFileResponse

Upload a file into a RagCorpus.

Overloads 
def upload_rag_file(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::UploadRagFileResponse
Pass arguments to upload_rag_file via a request object, either of type UploadRagFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::UploadRagFileRequest, ::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 upload_rag_file(parent: nil, rag_file: nil, upload_rag_file_config: nil) -> ::Google::Cloud::AIPlatform::V1::UploadRagFileResponse
Pass arguments to upload_rag_file 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::VertexRagDataService::Rest::Client.new

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

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

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