Interface SchemaPromptSpecStructuredPrompt (0.16.0)

Represents a structured prompt.

Package

@google-cloud/agentplatform

Properties

appBuilderData

appBuilderData?: SchemaPromptSpecAppBuilderData;

Data for app builder use case.

contentMetadata

contentMetadata?: SchemaPromptSpecContentMetadata[];

Optional. Metadata the model returned with each of prompt_message.contents, such as citations and grounding sources. This maps 1:1 to PromptMessage.contents; an entry is empty when its content has no metadata.

context

context?: genaiTypes.Content;

Preamble: The context of the prompt.

examples

examples?: SchemaPromptSpecPartList[];

Preamble: A set of examples for expected model response.

infillPrefix

infillPrefix?: string;

Preamble: For infill prompt, the prefix before expected model response.

infillSuffix

infillSuffix?: string;

Preamble: For infill prompt, the suffix after expected model response.

inputPrefixes

inputPrefixes?: string[];

Preamble: The input prefixes before each example input.

interactionData

interactionData?: SchemaPromptSpecInteractionData;

Data for interaction use case.

outputPrefixes

outputPrefixes?: string[];

Preamble: The output prefixes before each example output.

predictionInputs

predictionInputs?: SchemaPromptSpecPartList[];

Preamble: The input test data for prediction. Each PartList in this field represents one text-only input set for a single model request.

promptMessage

promptMessage?: SchemaPromptSpecPromptMessage;

The prompt message.