Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RagFile (v0.63.0)

Version 0.63.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.61.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

A RagFile contains user data for chunking, embedding and indexing.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this RagFile was created.

#description

def description() -> ::String

Returns

• (::String) — Optional. The description of the RagFile.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — Optional. The description of the RagFile.

Returns

• (::String) — Optional. The description of the RagFile.

#direct_upload_source

def direct_upload_source() -> ::Google::Cloud::AIPlatform::V1::DirectUploadSource

Returns

• (::Google::Cloud::AIPlatform::V1::DirectUploadSource) — Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

  Note: The following fields are mutually exclusive: direct_upload_source, gcs_source, google_drive_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#display_name

def display_name() -> ::String

Returns

• (::String) — Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns

• (::String) — Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#file_status

def file_status() -> ::Google::Cloud::AIPlatform::V1::FileStatus

Returns

• (::Google::Cloud::AIPlatform::V1::FileStatus) — Output only. State of the RagFile.

#gcs_source

def gcs_source() -> ::Google::Cloud::AIPlatform::V1::GcsSource

Returns

• (::Google::Cloud::AIPlatform::V1::GcsSource) — Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.

  Note: The following fields are mutually exclusive: gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#google_drive_source

def google_drive_source() -> ::Google::Cloud::AIPlatform::V1::GoogleDriveSource

Returns

• (::Google::Cloud::AIPlatform::V1::GoogleDriveSource) — Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

  Note: The following fields are mutually exclusive: google_drive_source, gcs_source, direct_upload_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#jira_source

def jira_source() -> ::Google::Cloud::AIPlatform::V1::JiraSource

Returns

• (::Google::Cloud::AIPlatform::V1::JiraSource) — The RagFile is imported from a Jira query.

  Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, direct_upload_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#jira_source=

def jira_source=(value) -> ::Google::Cloud::AIPlatform::V1::JiraSource

Parameter

• value (::Google::Cloud::AIPlatform::V1::JiraSource) — The RagFile is imported from a Jira query.

  Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, direct_upload_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::JiraSource) — The RagFile is imported from a Jira query.

  Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, direct_upload_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String

Returns

• (::String) — Output only. The resource name of the RagFile.

#share_point_sources

def share_point_sources() -> ::Google::Cloud::AIPlatform::V1::SharePointSources

Returns

• (::Google::Cloud::AIPlatform::V1::SharePointSources) — The RagFile is imported from a SharePoint source.

  Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#share_point_sources=

def share_point_sources=(value) -> ::Google::Cloud::AIPlatform::V1::SharePointSources

Parameter

• value (::Google::Cloud::AIPlatform::V1::SharePointSources) — The RagFile is imported from a SharePoint source.

  Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::SharePointSources) — The RagFile is imported from a SharePoint source.

  Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#slack_source

def slack_source() -> ::Google::Cloud::AIPlatform::V1::SlackSource

Returns

• (::Google::Cloud::AIPlatform::V1::SlackSource) — The RagFile is imported from a Slack channel.

  Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, direct_upload_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#slack_source=

def slack_source=(value) -> ::Google::Cloud::AIPlatform::V1::SlackSource

Parameter

• value (::Google::Cloud::AIPlatform::V1::SlackSource) — The RagFile is imported from a Slack channel.

  Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, direct_upload_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::SlackSource) — The RagFile is imported from a Slack channel.

  Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, direct_upload_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this RagFile was last updated.