Google Cloud Ai Platform V1 Client - Class RagFile (1.13.1)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class RagFile.

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

Generated from protobuf message google.cloud.aiplatform.v1.RagFile

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ gcs_source`	`GcsSource` Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.
`↳ google_drive_source`	`GoogleDriveSource` Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
`↳ direct_upload_source`	`DirectUploadSource` Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
`↳ slack_source`	`SlackSource` The RagFile is imported from a Slack channel.
`↳ jira_source`	`JiraSource` The RagFile is imported from a Jira query.
`↳ share_point_sources`	`SharePointSources` The RagFile is imported from a SharePoint source.
`↳ name`	`string` Output only. The resource name of the RagFile.
`↳ display_name`	`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.
`↳ description`	`string` Optional. The description of the RagFile.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this RagFile was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this RagFile was last updated.
`↳ file_status`	`FileStatus` Output only. State of the RagFile.

getGcsSource

Output only. Google Cloud Storage location of the RagFile.

It does not support wildcards in the Cloud Storage uri for now.

Returns
Type	Description
`GcsSource\|null`

hasGcsSource

setGcsSource

Output only. Google Cloud Storage location of the RagFile.

It does not support wildcards in the Cloud Storage uri for now.

Parameter
Name	Description
`var`	`GcsSource`

Returns
Type	Description
`$this`

getGoogleDriveSource

Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

Returns
Type	Description
`GoogleDriveSource\|null`

hasGoogleDriveSource

setGoogleDriveSource

Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

Parameter
Name	Description
`var`	`GoogleDriveSource`

Returns
Type	Description
`$this`

getDirectUploadSource

Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

Returns
Type	Description
`DirectUploadSource\|null`

hasDirectUploadSource

setDirectUploadSource

Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

Parameter
Name	Description
`var`	`DirectUploadSource`

Returns
Type	Description
`$this`

getSlackSource

The RagFile is imported from a Slack channel.

Returns
Type	Description
`SlackSource\|null`

hasSlackSource

setSlackSource

The RagFile is imported from a Slack channel.

Parameter
Name	Description
`var`	`SlackSource`

Returns
Type	Description
`$this`

getJiraSource

The RagFile is imported from a Jira query.

Returns
Type	Description
`JiraSource\|null`

hasJiraSource

setJiraSource

The RagFile is imported from a Jira query.

Parameter
Name	Description
`var`	`JiraSource`

Returns
Type	Description
`$this`

getSharePointSources

The RagFile is imported from a SharePoint source.

Returns
Type	Description
`SharePointSources\|null`

hasSharePointSources

setSharePointSources

The RagFile is imported from a SharePoint source.

Parameter
Name	Description
`var`	`SharePointSources`

Returns
Type	Description
`$this`

getName

Output only. The resource name of the RagFile.

Returns
Type	Description
`string`

setName

Output only. The resource name of the RagFile.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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
Type	Description
`string`

setDisplayName

Required. The display name of the RagFile.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. The description of the RagFile.

Returns
Type	Description
`string`

setDescription

Optional. The description of the RagFile.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when this RagFile was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this RagFile was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Timestamp when this RagFile was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this RagFile was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getFileStatus

Output only. State of the RagFile.

Returns
Type	Description
`FileStatus\|null`

hasFileStatus

clearFileStatus

setFileStatus

Output only. State of the RagFile.

Parameter
Name	Description
`var`	`FileStatus`

Returns
Type	Description
`$this`

getRagFileSource

Returns
Type	Description
`string`