@pulumi/gcp/vertex/getAiReasoningEngineQuery.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Get the output of a query sent to a Vertex AI Reasoning Engine agent.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as std from "@pulumi/std";
 *
 * const defaultAiReasoningEngine = new gcp.vertex.AiReasoningEngine("default", {
 *     displayName: "vertex-mds-_29506",
 *     description: "Retrieves tenant project number",
 *     region: "us-central1",
 *     spec: {
 *         sourceCodeSpec: {
 *             inlineSource: {
 *                 sourceArchive: std.filebase64({
 *                     input: "./test-fixtures/mds_agent_src.tar.gz",
 *                 }).then(invoke => invoke.result),
 *             },
 *             pythonSpec: {
 *                 entrypointModule: "metadata_agent",
 *                 entrypointObject: "root_agent",
 *             },
 *         },
 *     },
 * });
 * const _default = gcp.vertex.getAiReasoningEngineQueryOutput({
 *     reasoningEngineId: defaultAiReasoningEngine.name,
 *     region: "us-central1",
 *     classMethod: "query",
 * });
 * ```
 */
export declare function getAiReasoningEngineQuery(args: GetAiReasoningEngineQueryArgs, opts?: pulumi.InvokeOptions): Promise<GetAiReasoningEngineQueryResult>;
/**
 * A collection of arguments for invoking getAiReasoningEngineQuery.
 */
export interface GetAiReasoningEngineQueryArgs {
    /**
     * Class method to be used for the query. It is optional and defaults to "query" if unspecified.
     */
    classMethod?: string;
    /**
     * Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc..
     */
    input?: string;
    /**
     * The ID of the project in which the resource belongs. If it is not provided, the provider default project is used.
     */
    project?: string;
    /**
     * The ID of the Vertex AI Reasoning Engine to query.
     *
     * - - -
     */
    reasoningEngineId: string;
    /**
     * The location of the resource.
     */
    region: string;
}
/**
 * A collection of values returned by getAiReasoningEngineQuery.
 */
export interface GetAiReasoningEngineQueryResult {
    readonly classMethod?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly input?: string;
    /**
     * The JSON-serialized output resulting from the query.
     */
    readonly output: string;
    readonly project?: string;
    readonly reasoningEngineId: string;
    readonly region: string;
}
/**
 * Get the output of a query sent to a Vertex AI Reasoning Engine agent.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as std from "@pulumi/std";
 *
 * const defaultAiReasoningEngine = new gcp.vertex.AiReasoningEngine("default", {
 *     displayName: "vertex-mds-_29506",
 *     description: "Retrieves tenant project number",
 *     region: "us-central1",
 *     spec: {
 *         sourceCodeSpec: {
 *             inlineSource: {
 *                 sourceArchive: std.filebase64({
 *                     input: "./test-fixtures/mds_agent_src.tar.gz",
 *                 }).then(invoke => invoke.result),
 *             },
 *             pythonSpec: {
 *                 entrypointModule: "metadata_agent",
 *                 entrypointObject: "root_agent",
 *             },
 *         },
 *     },
 * });
 * const _default = gcp.vertex.getAiReasoningEngineQueryOutput({
 *     reasoningEngineId: defaultAiReasoningEngine.name,
 *     region: "us-central1",
 *     classMethod: "query",
 * });
 * ```
 */
export declare function getAiReasoningEngineQueryOutput(args: GetAiReasoningEngineQueryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAiReasoningEngineQueryResult>;
/**
 * A collection of arguments for invoking getAiReasoningEngineQuery.
 */
export interface GetAiReasoningEngineQueryOutputArgs {
    /**
     * Class method to be used for the query. It is optional and defaults to "query" if unspecified.
     */
    classMethod?: pulumi.Input<string | undefined>;
    /**
     * Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc..
     */
    input?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs. If it is not provided, the provider default project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The ID of the Vertex AI Reasoning Engine to query.
     *
     * - - -
     */
    reasoningEngineId: pulumi.Input<string>;
    /**
     * The location of the resource.
     */
    region: pulumi.Input<string>;
}
//# sourceMappingURL=getAiReasoningEngineQuery.d.ts.map