batchCreate(parent, body=None, x__xgafv=None)

Batch Create one or more RagMetadatas

Args:
  parent: string, Required. The parent resource where the RagMetadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for VertexRagDataService.BatchCreateRagMetadata.
  "requests": [ # Required. The request messages for VertexRagDataService.CreateRagMetadata. A maximum of 500 rag file metadata can be created in a batch.
    { # Request message for CreateRagMetadata.
      "parent": "A String", # Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
      "ragMetadata": { # Metadata for RagFile provided by users. # Required. The metadata to create.
        "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
        "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
          "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
          "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
            "boolValue": True or False, # Value of boolean type metadata.
            "datetimeValue": "A String", # Value of date time type metadata.
            "floatValue": 3.14, # Value of float type metadata.
            "intValue": "A String", # Value of int type metadata.
            "listValue": { # List representation in metadata. # Value of list type metadata.
              "values": [ # The values of `LIST` data type metadata.
                # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
              ],
            },
            "strValue": "A String", # Value of string type metadata.
          },
        },
      },
      "ragMetadataId": "A String", # Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

batchDelete(parent, body=None, x__xgafv=None)

Batch Deletes one or more RagMetadata.

Args:
parent: string, Required. The resource name of the RagFile from which to delete the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for VertexRagDataService.BatchDeleteRagMetadata.
"names": [ # Required. The RagMetadata to delete. A maximum of 500 rag metadata can be deleted in a batch.
"A String",
],
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

close()

Close httplib2 connections.

create(parent, body=None, ragMetadataId=None, x__xgafv=None)

Creates a RagMetadata.

Args:
  parent: string, Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata for RagFile provided by users.
  "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
  "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
    "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
    "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
      "boolValue": True or False, # Value of boolean type metadata.
      "datetimeValue": "A String", # Value of date time type metadata.
      "floatValue": 3.14, # Value of float type metadata.
      "intValue": "A String", # Value of int type metadata.
      "listValue": { # List representation in metadata. # Value of list type metadata.
        "values": [ # The values of `LIST` data type metadata.
          # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
        ],
      },
      "strValue": "A String", # Value of string type metadata.
    },
  },
}

  ragMetadataId: string, Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata for RagFile provided by users.
  "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
  "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
    "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
    "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
      "boolValue": True or False, # Value of boolean type metadata.
      "datetimeValue": "A String", # Value of date time type metadata.
      "floatValue": 3.14, # Value of float type metadata.
      "intValue": "A String", # Value of int type metadata.
      "listValue": { # List representation in metadata. # Value of list type metadata.
        "values": [ # The values of `LIST` data type metadata.
          # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
        ],
      },
      "strValue": "A String", # Value of string type metadata.
    },
  },
}

delete(name, x__xgafv=None)

Deletes a RagMetadata.

Args:
  name: string, Required. The name of the RagMetadata resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a RagMetadata.

Args:
  name: string, Required. The name of the RagMetadata resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata for RagFile provided by users.
  "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
  "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
    "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
    "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
      "boolValue": True or False, # Value of boolean type metadata.
      "datetimeValue": "A String", # Value of date time type metadata.
      "floatValue": 3.14, # Value of float type metadata.
      "intValue": "A String", # Value of int type metadata.
      "listValue": { # List representation in metadata. # Value of list type metadata.
        "values": [ # The values of `LIST` data type metadata.
          # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
        ],
      },
      "strValue": "A String", # Value of string type metadata.
    },
  },
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists RagMetadata in a RagFile.

Args:
  parent: string, Required. The resource name of the RagFile from which to list the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
  pageSize: integer, Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
  pageToken: string, Optional. The standard list page token. Typically obtained via ListRagMetadataResponse.next_page_token of the previous VertexRagDataService.ListRagMetadata call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for VertexRagDataService.ListRagMetadata.
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagMetadataRequest.page_token to obtain that page.
  "ragMetadata": [ # List of RagMetadata in the requested page.
    { # Metadata for RagFile provided by users.
      "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
      "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
        "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
        "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
          "boolValue": True or False, # Value of boolean type metadata.
          "datetimeValue": "A String", # Value of date time type metadata.
          "floatValue": 3.14, # Value of float type metadata.
          "intValue": "A String", # Value of int type metadata.
          "listValue": { # List representation in metadata. # Value of list type metadata.
            "values": [ # The values of `LIST` data type metadata.
              # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
            ],
          },
          "strValue": "A String", # Value of string type metadata.
        },
      },
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, x__xgafv=None)

Updates a RagMetadata.

Args:
  name: string, Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata for RagFile provided by users.
  "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
  "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
    "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
    "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
      "boolValue": True or False, # Value of boolean type metadata.
      "datetimeValue": "A String", # Value of date time type metadata.
      "floatValue": 3.14, # Value of float type metadata.
      "intValue": "A String", # Value of int type metadata.
      "listValue": { # List representation in metadata. # Value of list type metadata.
        "values": [ # The values of `LIST` data type metadata.
          # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
        ],
      },
      "strValue": "A String", # Value of string type metadata.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata for RagFile provided by users.
  "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
  "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
    "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
    "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
      "boolValue": True or False, # Value of boolean type metadata.
      "datetimeValue": "A String", # Value of date time type metadata.
      "floatValue": 3.14, # Value of float type metadata.
      "intValue": "A String", # Value of int type metadata.
      "listValue": { # List representation in metadata. # Value of list type metadata.
        "values": [ # The values of `LIST` data type metadata.
          # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
        ],
      },
      "strValue": "A String", # Value of string type metadata.
    },
  },
}

Vertex AI API . projects . locations . ragCorpora . ragFiles . ragMetadata

Instance Methods

Method Details