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

Creates an Evaluation Experiment.

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

{ # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
  "createTime": "A String", # Output only. Timestamp when this experiment was created.
  "displayName": "A String", # Required. The display name of the evaluation experiment.
  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
    "A String",
  ],
  "labels": { # Optional. Labels for the evaluation experiment.
    "a_key": "A String",
  },
  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
    "a_key": "", # Properties of the object.
  },
  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
}

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

Returns:
  An object of the form:

    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
  "createTime": "A String", # Output only. Timestamp when this experiment was created.
  "displayName": "A String", # Required. The display name of the evaluation experiment.
  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
    "A String",
  ],
  "labels": { # Optional. Labels for the evaluation experiment.
    "a_key": "A String",
  },
  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
    "a_key": "", # Properties of the object.
  },
  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
}

delete(name, x__xgafv=None)

Deletes an Evaluation Experiment.

Args:
name: string, Required. The name of the EvaluationExperiment resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` (required)
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.
},
}

get(name, x__xgafv=None)

Gets an Evaluation Experiment.

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

Returns:
  An object of the form:

    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
  "createTime": "A String", # Output only. Timestamp when this experiment was created.
  "displayName": "A String", # Required. The display name of the evaluation experiment.
  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
    "A String",
  ],
  "labels": { # Optional. Labels for the evaluation experiment.
    "a_key": "A String",
  },
  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
    "a_key": "", # Properties of the object.
  },
  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
}

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

Lists Evaluation Experiments.

Args:
  parent: string, Required. The resource name of the Location from which to list the Evaluation Experiments. Format: `projects/{project}/locations/{location}` (required)
  filter: string, Optional. Filter expression that matches a subset of the EvaluationExperiments to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
  pageSize: integer, Optional. The maximum number of Evaluation Experiments to return.
  pageToken: string, Optional. A page token, received from a previous `ListEvaluationExperiments` call. Provide this to retrieve the subsequent page.
  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 EvaluationManagementService.ListEvaluationExperiments.
  "evaluationExperiments": [ # List of EvaluationExperiments in the requested page.
    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
      "createTime": "A String", # Output only. Timestamp when this experiment was created.
      "displayName": "A String", # Required. The display name of the evaluation experiment.
      "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
        "A String",
      ],
      "labels": { # Optional. Labels for the evaluation experiment.
        "a_key": "A String",
      },
      "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
        "a_key": "", # Properties of the object.
      },
      "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
      "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results.
}

list_next(previous_request, previous_response)

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, updateMask=None, x__xgafv=None)

Updates an Evaluation Experiment.

Args:
  name: string, Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` (required)
  body: object, The request body.
    The object takes the form of:

{ # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
  "createTime": "A String", # Output only. Timestamp when this experiment was created.
  "displayName": "A String", # Required. The display name of the evaluation experiment.
  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
    "A String",
  ],
  "labels": { # Optional. Labels for the evaluation experiment.
    "a_key": "A String",
  },
  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
    "a_key": "", # Properties of the object.
  },
  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
}

  updateMask: string, Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
  "createTime": "A String", # Output only. Timestamp when this experiment was created.
  "displayName": "A String", # Required. The display name of the evaluation experiment.
  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
    "A String",
  ],
  "labels": { # Optional. Labels for the evaluation experiment.
    "a_key": "A String",
  },
  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
    "a_key": "", # Properties of the object.
  },
  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
}

Agent Platform API . projects . locations . evaluationExperiments

Instance Methods

Method Details