close()

Close httplib2 connections.

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

Creates a reasoning engine.

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

{ # ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.
"createTime": "A String", # Output only. Timestamp when this ReasoningEngine was created.
"description": "A String", # Optional. The description of the ReasoningEngine.
"displayName": "A String", # Required. The display name of the ReasoningEngine.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"name": "A String", # Identifier. The resource name of the ReasoningEngine.
"spec": { # ReasoningEngine configurations # Required. Configurations of the ReasoningEngine
"classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
{
"a_key": "", # Properties of the object.
},
],
"packageSpec": { # User provided package spec like pickled object and package requirements. # Required. User provided package spec of the ReasoningEngine.
"dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
"pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
"pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
"requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
},
},
"updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
}

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.
},
}

delete(name, x__xgafv=None)

Deletes a reasoning engine.

Args:
name: string, Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (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 a reasoning engine.

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

Returns:
  An object of the form:

    { # ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.
  "createTime": "A String", # Output only. Timestamp when this ReasoningEngine was created.
  "description": "A String", # Optional. The description of the ReasoningEngine.
  "displayName": "A String", # Required. The display name of the ReasoningEngine.
  "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "name": "A String", # Identifier. The resource name of the ReasoningEngine.
  "spec": { # ReasoningEngine configurations # Required. Configurations of the ReasoningEngine
    "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
      {
        "a_key": "", # Properties of the object.
      },
    ],
    "packageSpec": { # User provided package spec like pickled object and package requirements. # Required. User provided package spec of the ReasoningEngine.
      "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
      "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
      "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
      "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
    },
  },
  "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
}

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

Lists reasoning engines in a location.

Args:
  parent: string, Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}` (required)
  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
  pageSize: integer, Optional. The standard list page size.
  pageToken: string, Optional. The standard list page token.
  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 ReasoningEngineService.ListReasoningEngines
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListReasoningEnginesRequest.page_token to obtain that page.
  "reasoningEngines": [ # List of ReasoningEngines in the requested page.
    { # ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.
      "createTime": "A String", # Output only. Timestamp when this ReasoningEngine was created.
      "description": "A String", # Optional. The description of the ReasoningEngine.
      "displayName": "A String", # Required. The display name of the ReasoningEngine.
      "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "name": "A String", # Identifier. The resource name of the ReasoningEngine.
      "spec": { # ReasoningEngine configurations # Required. Configurations of the ReasoningEngine
        "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
          {
            "a_key": "", # Properties of the object.
          },
        ],
        "packageSpec": { # User provided package spec like pickled object and package requirements. # Required. User provided package spec of the ReasoningEngine.
          "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
          "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
          "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
          "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
        },
      },
      "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
    },
  ],
}

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

Updates a reasoning engine.

Args:
  name: string, Identifier. The resource name of the ReasoningEngine. (required)
  body: object, The request body.
    The object takes the form of:

{ # ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.
  "createTime": "A String", # Output only. Timestamp when this ReasoningEngine was created.
  "description": "A String", # Optional. The description of the ReasoningEngine.
  "displayName": "A String", # Required. The display name of the ReasoningEngine.
  "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "name": "A String", # Identifier. The resource name of the ReasoningEngine.
  "spec": { # ReasoningEngine configurations # Required. Configurations of the ReasoningEngine
    "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
      {
        "a_key": "", # Properties of the object.
      },
    ],
    "packageSpec": { # User provided package spec like pickled object and package requirements. # Required. User provided package spec of the ReasoningEngine.
      "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
      "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
      "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
      "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
    },
  },
  "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
}

  updateMask: string, Optional. Mask specifying which fields to update.
  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.
  },
}

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

Queries using a reasoning engine.

Args:
  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ReasoningEngineExecutionService.Query.
  "classMethod": "A String", # Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
    "a_key": "", # Properties of the object.
  },
}

  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 ReasoningEngineExecutionService.Query
  "output": "", # Response provided by users in JSON object format.
}

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

Streams queries using a reasoning engine.

Args:
  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ReasoningEngineExecutionService.StreamQuery.
  "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
    "a_key": "", # Properties of the object.
  },
}

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

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

Vertex AI API . projects . locations . reasoningEngines

Instance Methods

Method Details