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

Batch Create one or more RagDataSchemas

Args:
parent: string, Required. The resource name of the RagCorpus to create the RagDataSchemas in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for VertexRagDataService.BatchCreateRagDataSchemas.
"requests": [ # Required. The request messages for VertexRagDataService.CreateRagDataSchema. A maximum of 500 schemas can be created in a batch.
{ # Request message for VertexRagDataService.CreateRagDataSchema.
"parent": "A String", # Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
"ragDataSchema": { # The schema of the user specified metadata. # Required. The RagDataSchema to create.
"key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can 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.
"name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
"schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
"granularity": "A String", # The granularity associated with this RagMetadataSchema.
"listConfig": { # Config for List data type. # Config for List data type.
"valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
},
"searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
"searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
},
"type": "A String", # Type of the metadata.
},
},
"ragDataSchemaId": "A String", # Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema 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 RagDataSchemas

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

{ # Request message for VertexRagDataService.BatchDeleteRagDataSchemas.
"names": [ # Required. The RagDataSchemas to delete. A maximum of 500 schemas can be deleted in a batch. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`
"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, ragDataSchemaId=None, x__xgafv=None)

Creates a RagDataSchema.

Args:
parent: string, Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
body: object, The request body.
The object takes the form of:

{ # The schema of the user specified metadata.
"key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can 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.
"name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
"schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
"granularity": "A String", # The granularity associated with this RagMetadataSchema.
"listConfig": { # Config for List data type. # Config for List data type.
"valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
},
"searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
"searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
},
"type": "A String", # Type of the metadata.
},
}

ragDataSchemaId: string, Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema 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:

{ # The schema of the user specified metadata.
"key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can 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.
"name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
"schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
"granularity": "A String", # The granularity associated with this RagMetadataSchema.
"listConfig": { # Config for List data type. # Config for List data type.
"valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
},
"searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
"searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
},
"type": "A String", # Type of the metadata.
},
}

delete(name, x__xgafv=None)

Deletes a RagDataSchema.

Args:
  name: string, Required. The name of the RagDataSchema resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` (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 RagDataSchema.

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

Returns:
  An object of the form:

    { # The schema of the user specified metadata.
  "key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can 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.
  "name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
  "schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
    "granularity": "A String", # The granularity associated with this RagMetadataSchema.
    "listConfig": { # Config for List data type. # Config for List data type.
      "valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
    },
    "searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
      "searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
    },
    "type": "A String", # Type of the metadata.
  },
}

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

Lists RagDataSchemas in a Location.

Args:
parent: string, Required. The resource name of the RagCorpus from which to list the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (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 ListRagDataSchemasResponse.next_page_token of the previous VertexRagDataService.ListRagDataSchemas 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.ListRagDataSchemas.
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagDataSchemasRequest.page_token to obtain that page.
"ragDataSchemas": [ # List of RagDataSchemas in the requested page.
{ # The schema of the user specified metadata.
"key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can 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.
"name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
"schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
"granularity": "A String", # The granularity associated with this RagMetadataSchema.
"listConfig": { # Config for List data type. # Config for List data type.
"valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
},
"searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
"searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
},
"type": "A String", # Type of the 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.

Vertex AI API . projects . locations . ragCorpora . ragDataSchemas

Instance Methods

Method Details