Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. discoveryengine
  5. discoveryengine/v1alpha
  6. Conversation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.discoveryengine/v1alpha.Conversation

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.

    Create Conversation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Conversation(name: string, args: ConversationArgs, opts?: CustomResourceOptions);
    @overload
def Conversation(resource_name: str,
                 args: ConversationArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Conversation(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 collection_id: Optional[str] = None,
                 data_store_id: Optional[str] = None,
                 location: Optional[str] = None,
                 messages: Optional[Sequence[GoogleCloudDiscoveryengineV1alphaConversationMessageArgs]] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 state: Optional[ConversationState] = None,
                 user_pseudo_id: Optional[str] = None)
    func NewConversation(ctx *Context, name string, args ConversationArgs, opts ...ResourceOption) (*Conversation, error)
    public Conversation(string name, ConversationArgs args, CustomResourceOptions? opts = null)
    public Conversation(String name, ConversationArgs args)
public Conversation(String name, ConversationArgs args, CustomResourceOptions options)

    type: google-native:discoveryengine/v1alpha:Conversation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ConversationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConversationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConversationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConversationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConversationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleconversationResourceResourceFromDiscoveryenginev1alpha = new GoogleNative.DiscoveryEngine.V1Alpha.Conversation("exampleconversationResourceResourceFromDiscoveryenginev1alpha", new()
{
    CollectionId = "string",
    DataStoreId = "string",
    Location = "string",
    Messages = new[]
    {
        new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaConversationMessageArgs
        {
            Reply = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaReplyArgs
            {
                References = new[]
                {
                    new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaReplyReferenceArgs
                    {
                        AnchorText = "string",
                        End = 0,
                        Start = 0,
                        Uri = "string",
                    },
                },
                Summary = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryArgs
                {
                    SafetyAttributes = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesArgs
                    {
                        Categories = new[]
                        {
                            "string",
                        },
                        Scores = new[]
                        {
                            0,
                        },
                    },
                    SummarySkippedReasons = new[]
                    {
                        GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem.SummarySkippedReasonUnspecified,
                    },
                    SummaryText = "string",
                },
            },
            UserInput = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaTextInputArgs
            {
                Context = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaConversationContextArgs
                {
                    ActiveDocument = "string",
                    ContextDocuments = new[]
                    {
                        "string",
                    },
                },
                Input = "string",
            },
        },
    },
    Name = "string",
    Project = "string",
    State = GoogleNative.DiscoveryEngine.V1Alpha.ConversationState.StateUnspecified,
    UserPseudoId = "string",
});

    example, err := discoveryengine.NewConversation(ctx, "exampleconversationResourceResourceFromDiscoveryenginev1alpha", &discoveryengine.ConversationArgs{
CollectionId: pulumi.String("string"),
DataStoreId: pulumi.String("string"),
Location: pulumi.String("string"),
Messages: discoveryengine.GoogleCloudDiscoveryengineV1alphaConversationMessageArray{
&discoveryengine.GoogleCloudDiscoveryengineV1alphaConversationMessageArgs{
Reply: &discoveryengine.GoogleCloudDiscoveryengineV1alphaReplyArgs{
References: discoveryengine.GoogleCloudDiscoveryengineV1alphaReplyReferenceArray{
&discoveryengine.GoogleCloudDiscoveryengineV1alphaReplyReferenceArgs{
AnchorText: pulumi.String("string"),
End: pulumi.Int(0),
Start: pulumi.Int(0),
Uri: pulumi.String("string"),
},
},
Summary: &discoveryengine.GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryArgs{
SafetyAttributes: &discoveryengine.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesArgs{
Categories: pulumi.StringArray{
pulumi.String("string"),
},
Scores: pulumi.Float64Array{
pulumi.Float64(0),
},
},
SummarySkippedReasons: discoveryengine.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemArray{
discoveryengine.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemSummarySkippedReasonUnspecified,
},
SummaryText: pulumi.String("string"),
},
},
UserInput: &discoveryengine.GoogleCloudDiscoveryengineV1alphaTextInputArgs{
Context: &discoveryengine.GoogleCloudDiscoveryengineV1alphaConversationContextArgs{
ActiveDocument: pulumi.String("string"),
ContextDocuments: pulumi.StringArray{
pulumi.String("string"),
},
},
Input: pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
State: discoveryengine.ConversationStateStateUnspecified,
UserPseudoId: pulumi.String("string"),
})

    var exampleconversationResourceResourceFromDiscoveryenginev1alpha = new Conversation("exampleconversationResourceResourceFromDiscoveryenginev1alpha", ConversationArgs.builder()        
    .collectionId("string")
    .dataStoreId("string")
    .location("string")
    .messages(GoogleCloudDiscoveryengineV1alphaConversationMessageArgs.builder()
        .reply(GoogleCloudDiscoveryengineV1alphaReplyArgs.builder()
            .references(GoogleCloudDiscoveryengineV1alphaReplyReferenceArgs.builder()
                .anchorText("string")
                .end(0)
                .start(0)
                .uri("string")
                .build())
            .summary(GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryArgs.builder()
                .safetyAttributes(GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesArgs.builder()
                    .categories("string")
                    .scores(0)
                    .build())
                .summarySkippedReasons("SUMMARY_SKIPPED_REASON_UNSPECIFIED")
                .summaryText("string")
                .build())
            .build())
        .userInput(GoogleCloudDiscoveryengineV1alphaTextInputArgs.builder()
            .context(GoogleCloudDiscoveryengineV1alphaConversationContextArgs.builder()
                .activeDocument("string")
                .contextDocuments("string")
                .build())
            .input("string")
            .build())
        .build())
    .name("string")
    .project("string")
    .state("STATE_UNSPECIFIED")
    .userPseudoId("string")
    .build());

    exampleconversation_resource_resource_from_discoveryenginev1alpha = google_native.discoveryengine.v1alpha.Conversation("exampleconversationResourceResourceFromDiscoveryenginev1alpha",
    collection_id="string",
    data_store_id="string",
    location="string",
    messages=[google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaConversationMessageArgs(
        reply=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaReplyArgs(
            references=[google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaReplyReferenceArgs(
                anchor_text="string",
                end=0,
                start=0,
                uri="string",
            )],
            summary=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryArgs(
                safety_attributes=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesArgs(
                    categories=["string"],
                    scores=[0],
                ),
                summary_skipped_reasons=[google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem.SUMMARY_SKIPPED_REASON_UNSPECIFIED],
                summary_text="string",
            ),
        ),
        user_input=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaTextInputArgs(
            context=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaConversationContextArgs(
                active_document="string",
                context_documents=["string"],
            ),
            input="string",
        ),
    )],
    name="string",
    project="string",
    state=google_native.discoveryengine.v1alpha.ConversationState.STATE_UNSPECIFIED,
    user_pseudo_id="string")

    const exampleconversationResourceResourceFromDiscoveryenginev1alpha = new google_native.discoveryengine.v1alpha.Conversation("exampleconversationResourceResourceFromDiscoveryenginev1alpha", {
    collectionId: "string",
    dataStoreId: "string",
    location: "string",
    messages: [{
        reply: {
            references: [{
                anchorText: "string",
                end: 0,
                start: 0,
                uri: "string",
            }],
            summary: {
                safetyAttributes: {
                    categories: ["string"],
                    scores: [0],
                },
                summarySkippedReasons: [google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem.SummarySkippedReasonUnspecified],
                summaryText: "string",
            },
        },
        userInput: {
            context: {
                activeDocument: "string",
                contextDocuments: ["string"],
            },
            input: "string",
        },
    }],
    name: "string",
    project: "string",
    state: google_native.discoveryengine.v1alpha.ConversationState.StateUnspecified,
    userPseudoId: "string",
});

    type: google-native:discoveryengine/v1alpha:Conversation
properties:
    collectionId: string
    dataStoreId: string
    location: string
    messages:
        - reply:
            references:
                - anchorText: string
                  end: 0
                  start: 0
                  uri: string
            summary:
                safetyAttributes:
                    categories:
                        - string
                    scores:
                        - 0
                summarySkippedReasons:
                    - SUMMARY_SKIPPED_REASON_UNSPECIFIED
                summaryText: string
          userInput:
            context:
                activeDocument: string
                contextDocuments:
                    - string
            input: string
    name: string
    project: string
    state: STATE_UNSPECIFIED
    userPseudoId: string

    Conversation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Conversation resource accepts the following input properties:

    CollectionId string
    DataStoreId string
    Location string
    Messages List<Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaConversationMessage>
    Conversation messages.
    Name string
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    Project string
    State Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.ConversationState
    The state of the Conversation.
    UserPseudoId string
    A unique identifier for tracking users.
    CollectionId string
    DataStoreId string
    Location string
    Messages []GoogleCloudDiscoveryengineV1alphaConversationMessageArgs
    Conversation messages.
    Name string
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    Project string
    State ConversationStateEnum
    The state of the Conversation.
    UserPseudoId string
    A unique identifier for tracking users.
    collectionId String
    dataStoreId String
    location String
    messages List<GoogleCloudDiscoveryengineV1alphaConversationMessage>
    Conversation messages.
    name String
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    project String
    state ConversationState
    The state of the Conversation.
    userPseudoId String
    A unique identifier for tracking users.
    collectionId string
    dataStoreId string
    location string
    messages GoogleCloudDiscoveryengineV1alphaConversationMessage[]
    Conversation messages.
    name string
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    project string
    state ConversationState
    The state of the Conversation.
    userPseudoId string
    A unique identifier for tracking users.
    collection_id str
    data_store_id str
    location str
    messages Sequence[GoogleCloudDiscoveryengineV1alphaConversationMessageArgs]
    Conversation messages.
    name str
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    project str
    state ConversationState
    The state of the Conversation.
    user_pseudo_id str
    A unique identifier for tracking users.
    collectionId String
    dataStoreId String
    location String
    messages List<Property Map>
    Conversation messages.
    name String
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    project String
    state "STATE_UNSPECIFIED" | "IN_PROGRESS" | "COMPLETED"
    The state of the Conversation.
    userPseudoId String
    A unique identifier for tracking users.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Conversation resource produces the following output properties:

    EndTime string
    The time the conversation finished.
    Id string
    The provider-assigned unique ID for this managed resource.
    StartTime string
    The time the conversation started.
    EndTime string
    The time the conversation finished.
    Id string
    The provider-assigned unique ID for this managed resource.
    StartTime string
    The time the conversation started.
    endTime String
    The time the conversation finished.
    id String
    The provider-assigned unique ID for this managed resource.
    startTime String
    The time the conversation started.
    endTime string
    The time the conversation finished.
    id string
    The provider-assigned unique ID for this managed resource.
    startTime string
    The time the conversation started.
    end_time str
    The time the conversation finished.
    id str
    The provider-assigned unique ID for this managed resource.
    start_time str
    The time the conversation started.
    endTime String
    The time the conversation finished.
    id String
    The provider-assigned unique ID for this managed resource.
    startTime String
    The time the conversation started.

    Supporting Types

    ConversationState, ConversationStateArgs

    StateUnspecified
    STATE_UNSPECIFIEDUnknown.
    InProgress
    IN_PROGRESSConversation is currently open.
    Completed
    COMPLETEDConversation has been completed.
    ConversationStateStateUnspecified
    STATE_UNSPECIFIEDUnknown.
    ConversationStateInProgress
    IN_PROGRESSConversation is currently open.
    ConversationStateCompleted
    COMPLETEDConversation has been completed.
    StateUnspecified
    STATE_UNSPECIFIEDUnknown.
    InProgress
    IN_PROGRESSConversation is currently open.
    Completed
    COMPLETEDConversation has been completed.
    StateUnspecified
    STATE_UNSPECIFIEDUnknown.
    InProgress
    IN_PROGRESSConversation is currently open.
    Completed
    COMPLETEDConversation has been completed.
    STATE_UNSPECIFIED
    STATE_UNSPECIFIEDUnknown.
    IN_PROGRESS
    IN_PROGRESSConversation is currently open.
    COMPLETED
    COMPLETEDConversation has been completed.
    "STATE_UNSPECIFIED"
    STATE_UNSPECIFIEDUnknown.
    "IN_PROGRESS"
    IN_PROGRESSConversation is currently open.
    "COMPLETED"
    COMPLETEDConversation has been completed.

    GoogleCloudDiscoveryengineV1alphaConversationContext, GoogleCloudDiscoveryengineV1alphaConversationContextArgs

    ActiveDocument string
    The current active document the user opened. It contains the document resource reference.
    ContextDocuments List<string>
    The current list of documents the user is seeing. It contains the document resource references.
    ActiveDocument string
    The current active document the user opened. It contains the document resource reference.
    ContextDocuments []string
    The current list of documents the user is seeing. It contains the document resource references.
    activeDocument String
    The current active document the user opened. It contains the document resource reference.
    contextDocuments List<String>
    The current list of documents the user is seeing. It contains the document resource references.
    activeDocument string
    The current active document the user opened. It contains the document resource reference.
    contextDocuments string[]
    The current list of documents the user is seeing. It contains the document resource references.
    active_document str
    The current active document the user opened. It contains the document resource reference.
    context_documents Sequence[str]
    The current list of documents the user is seeing. It contains the document resource references.
    activeDocument String
    The current active document the user opened. It contains the document resource reference.
    contextDocuments List<String>
    The current list of documents the user is seeing. It contains the document resource references.

    GoogleCloudDiscoveryengineV1alphaConversationContextResponse, GoogleCloudDiscoveryengineV1alphaConversationContextResponseArgs

    ActiveDocument string
    The current active document the user opened. It contains the document resource reference.
    ContextDocuments List<string>
    The current list of documents the user is seeing. It contains the document resource references.
    ActiveDocument string
    The current active document the user opened. It contains the document resource reference.
    ContextDocuments []string
    The current list of documents the user is seeing. It contains the document resource references.
    activeDocument String
    The current active document the user opened. It contains the document resource reference.
    contextDocuments List<String>
    The current list of documents the user is seeing. It contains the document resource references.
    activeDocument string
    The current active document the user opened. It contains the document resource reference.
    contextDocuments string[]
    The current list of documents the user is seeing. It contains the document resource references.
    active_document str
    The current active document the user opened. It contains the document resource reference.
    context_documents Sequence[str]
    The current list of documents the user is seeing. It contains the document resource references.
    activeDocument String
    The current active document the user opened. It contains the document resource reference.
    contextDocuments List<String>
    The current list of documents the user is seeing. It contains the document resource references.

    GoogleCloudDiscoveryengineV1alphaConversationMessage, GoogleCloudDiscoveryengineV1alphaConversationMessageArgs

    reply Property Map
    Search reply.
    userInput Property Map
    User text input.

    GoogleCloudDiscoveryengineV1alphaConversationMessageResponse, GoogleCloudDiscoveryengineV1alphaConversationMessageResponseArgs

    createTime String
    Message creation timestamp.
    reply Property Map
    Search reply.
    userInput Property Map
    User text input.

    GoogleCloudDiscoveryengineV1alphaReply, GoogleCloudDiscoveryengineV1alphaReplyArgs

    References List<Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaReplyReference>
    References in the reply.
    Reply string
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    Summary Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
    Summary based on search results.
    References []GoogleCloudDiscoveryengineV1alphaReplyReference
    References in the reply.
    Reply string
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    Summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
    Summary based on search results.
    references List<GoogleCloudDiscoveryengineV1alphaReplyReference>
    References in the reply.
    reply String
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
    Summary based on search results.
    references GoogleCloudDiscoveryengineV1alphaReplyReference[]
    References in the reply.
    reply string
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
    Summary based on search results.
    references Sequence[GoogleCloudDiscoveryengineV1alphaReplyReference]
    References in the reply.
    reply str
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
    Summary based on search results.
    references List<Property Map>
    References in the reply.
    reply String
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary Property Map
    Summary based on search results.

    GoogleCloudDiscoveryengineV1alphaReplyReference, GoogleCloudDiscoveryengineV1alphaReplyReferenceArgs

    AnchorText string
    Anchor text.
    End int
    Anchor text end index.
    Start int
    Anchor text start index.
    Uri string
    URI link reference.
    AnchorText string
    Anchor text.
    End int
    Anchor text end index.
    Start int
    Anchor text start index.
    Uri string
    URI link reference.
    anchorText String
    Anchor text.
    end Integer
    Anchor text end index.
    start Integer
    Anchor text start index.
    uri String
    URI link reference.
    anchorText string
    Anchor text.
    end number
    Anchor text end index.
    start number
    Anchor text start index.
    uri string
    URI link reference.
    anchor_text str
    Anchor text.
    end int
    Anchor text end index.
    start int
    Anchor text start index.
    uri str
    URI link reference.
    anchorText String
    Anchor text.
    end Number
    Anchor text end index.
    start Number
    Anchor text start index.
    uri String
    URI link reference.

    GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse, GoogleCloudDiscoveryengineV1alphaReplyReferenceResponseArgs

    AnchorText string
    Anchor text.
    End int
    Anchor text end index.
    Start int
    Anchor text start index.
    Uri string
    URI link reference.
    AnchorText string
    Anchor text.
    End int
    Anchor text end index.
    Start int
    Anchor text start index.
    Uri string
    URI link reference.
    anchorText String
    Anchor text.
    end Integer
    Anchor text end index.
    start Integer
    Anchor text start index.
    uri String
    URI link reference.
    anchorText string
    Anchor text.
    end number
    Anchor text end index.
    start number
    Anchor text start index.
    uri string
    URI link reference.
    anchor_text str
    Anchor text.
    end int
    Anchor text end index.
    start int
    Anchor text start index.
    uri str
    URI link reference.
    anchorText String
    Anchor text.
    end Number
    Anchor text end index.
    start Number
    Anchor text start index.
    uri String
    URI link reference.

    GoogleCloudDiscoveryengineV1alphaReplyResponse, GoogleCloudDiscoveryengineV1alphaReplyResponseArgs

    References List<Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse>
    References in the reply.
    Reply string
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    Summary Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse
    Summary based on search results.
    References []GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse
    References in the reply.
    Reply string
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    Summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse
    Summary based on search results.
    references List<GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse>
    References in the reply.
    reply String
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse
    Summary based on search results.
    references GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse[]
    References in the reply.
    reply string
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse
    Summary based on search results.
    references Sequence[GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse]
    References in the reply.
    reply str
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse
    Summary based on search results.
    references List<Property Map>
    References in the reply.
    reply String
    DEPRECATED: use summary instead. Text reply.

    Deprecated: DEPRECATED: use summary instead. Text reply.

    summary Property Map
    Summary based on search results.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummary, GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryArgs

    SafetyAttributes Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
    A collection of Safety Attribute categories and their associated confidence scores.
    SummarySkippedReasons List<Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem>
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    SummaryText string
    The summary content.
    SafetyAttributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
    A collection of Safety Attribute categories and their associated confidence scores.
    SummarySkippedReasons []GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    SummaryText string
    The summary content.
    safetyAttributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
    A collection of Safety Attribute categories and their associated confidence scores.
    summarySkippedReasons List<GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem>
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summaryText String
    The summary content.
    safetyAttributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
    A collection of Safety Attribute categories and their associated confidence scores.
    summarySkippedReasons GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem[]
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summaryText string
    The summary content.
    safety_attributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
    A collection of Safety Attribute categories and their associated confidence scores.
    summary_skipped_reasons Sequence[GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem]
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summary_text str
    The summary content.
    safetyAttributes Property Map
    A collection of Safety Attribute categories and their associated confidence scores.
    summarySkippedReasons List<"SUMMARY_SKIPPED_REASON_UNSPECIFIED" | "ADVERSARIAL_QUERY_IGNORED" | "NON_SUMMARY_SEEKING_QUERY_IGNORED" | "OUT_OF_DOMAIN_QUERY_IGNORED" | "POTENTIAL_POLICY_VIOLATION" | "LLM_ADDON_NOT_ENABLED">
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summaryText String
    The summary content.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse, GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponseArgs

    SafetyAttributes Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse
    A collection of Safety Attribute categories and their associated confidence scores.
    SummarySkippedReasons List<string>
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    SummaryText string
    The summary content.
    SafetyAttributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse
    A collection of Safety Attribute categories and their associated confidence scores.
    SummarySkippedReasons []string
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    SummaryText string
    The summary content.
    safetyAttributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse
    A collection of Safety Attribute categories and their associated confidence scores.
    summarySkippedReasons List<String>
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summaryText String
    The summary content.
    safetyAttributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse
    A collection of Safety Attribute categories and their associated confidence scores.
    summarySkippedReasons string[]
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summaryText string
    The summary content.
    safety_attributes GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse
    A collection of Safety Attribute categories and their associated confidence scores.
    summary_skipped_reasons Sequence[str]
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summary_text str
    The summary content.
    safetyAttributes Property Map
    A collection of Safety Attribute categories and their associated confidence scores.
    summarySkippedReasons List<String>
    Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    summaryText String
    The summary content.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes, GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesArgs

    Categories List<string>
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    Scores List<double>
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    Categories []string
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    Scores []float64
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories List<String>
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores List<Double>
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories string[]
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores number[]
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories Sequence[str]
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores Sequence[float]
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories List<String>
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores List<Number>
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse, GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponseArgs

    Categories List<string>
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    Scores List<double>
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    Categories []string
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    Scores []float64
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories List<String>
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores List<Double>
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories string[]
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores number[]
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories Sequence[str]
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores Sequence[float]
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
    categories List<String>
    The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
    scores List<Number>
    The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem, GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemArgs

    SummarySkippedReasonUnspecified
    SUMMARY_SKIPPED_REASON_UNSPECIFIEDDefault value. The summary skipped reason is not specified.
    AdversarialQueryIgnored
    ADVERSARIAL_QUERY_IGNOREDThe adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to true.
    NonSummarySeekingQueryIgnored
    NON_SUMMARY_SEEKING_QUERY_IGNOREDThe non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to true.
    OutOfDomainQueryIgnored
    OUT_OF_DOMAIN_QUERY_IGNOREDThe out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
    PotentialPolicyViolation
    POTENTIAL_POLICY_VIOLATIONThe potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
    LlmAddonNotEnabled
    LLM_ADDON_NOT_ENABLEDThe LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.
    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemSummarySkippedReasonUnspecified
    SUMMARY_SKIPPED_REASON_UNSPECIFIEDDefault value. The summary skipped reason is not specified.
    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemAdversarialQueryIgnored
    ADVERSARIAL_QUERY_IGNOREDThe adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to true.
    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemNonSummarySeekingQueryIgnored
    NON_SUMMARY_SEEKING_QUERY_IGNOREDThe non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to true.
    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemOutOfDomainQueryIgnored
    OUT_OF_DOMAIN_QUERY_IGNOREDThe out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemPotentialPolicyViolation
    POTENTIAL_POLICY_VIOLATIONThe potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItemLlmAddonNotEnabled
    LLM_ADDON_NOT_ENABLEDThe LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.
    SummarySkippedReasonUnspecified
    SUMMARY_SKIPPED_REASON_UNSPECIFIEDDefault value. The summary skipped reason is not specified.
    AdversarialQueryIgnored
    ADVERSARIAL_QUERY_IGNOREDThe adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to true.
    NonSummarySeekingQueryIgnored
    NON_SUMMARY_SEEKING_QUERY_IGNOREDThe non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to true.
    OutOfDomainQueryIgnored
    OUT_OF_DOMAIN_QUERY_IGNOREDThe out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
    PotentialPolicyViolation
    POTENTIAL_POLICY_VIOLATIONThe potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
    LlmAddonNotEnabled
    LLM_ADDON_NOT_ENABLEDThe LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.
    SummarySkippedReasonUnspecified
    SUMMARY_SKIPPED_REASON_UNSPECIFIEDDefault value. The summary skipped reason is not specified.
    AdversarialQueryIgnored
    ADVERSARIAL_QUERY_IGNOREDThe adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to true.
    NonSummarySeekingQueryIgnored
    NON_SUMMARY_SEEKING_QUERY_IGNOREDThe non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to true.
    OutOfDomainQueryIgnored
    OUT_OF_DOMAIN_QUERY_IGNOREDThe out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
    PotentialPolicyViolation
    POTENTIAL_POLICY_VIOLATIONThe potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
    LlmAddonNotEnabled
    LLM_ADDON_NOT_ENABLEDThe LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.
    SUMMARY_SKIPPED_REASON_UNSPECIFIED
    SUMMARY_SKIPPED_REASON_UNSPECIFIEDDefault value. The summary skipped reason is not specified.
    ADVERSARIAL_QUERY_IGNORED
    ADVERSARIAL_QUERY_IGNOREDThe adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to true.
    NON_SUMMARY_SEEKING_QUERY_IGNORED
    NON_SUMMARY_SEEKING_QUERY_IGNOREDThe non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to true.
    OUT_OF_DOMAIN_QUERY_IGNORED
    OUT_OF_DOMAIN_QUERY_IGNOREDThe out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
    POTENTIAL_POLICY_VIOLATION
    POTENTIAL_POLICY_VIOLATIONThe potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
    LLM_ADDON_NOT_ENABLED
    LLM_ADDON_NOT_ENABLEDThe LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.
    "SUMMARY_SKIPPED_REASON_UNSPECIFIED"
    SUMMARY_SKIPPED_REASON_UNSPECIFIEDDefault value. The summary skipped reason is not specified.
    "ADVERSARIAL_QUERY_IGNORED"
    ADVERSARIAL_QUERY_IGNOREDThe adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to true.
    "NON_SUMMARY_SEEKING_QUERY_IGNORED"
    NON_SUMMARY_SEEKING_QUERY_IGNOREDThe non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to true.
    "OUT_OF_DOMAIN_QUERY_IGNORED"
    OUT_OF_DOMAIN_QUERY_IGNOREDThe out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
    "POTENTIAL_POLICY_VIOLATION"
    POTENTIAL_POLICY_VIOLATIONThe potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
    "LLM_ADDON_NOT_ENABLED"
    LLM_ADDON_NOT_ENABLEDThe LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.

    GoogleCloudDiscoveryengineV1alphaTextInput, GoogleCloudDiscoveryengineV1alphaTextInputArgs

    Context GoogleCloudDiscoveryengineV1alphaConversationContext
    Conversation context of the input.
    Input string
    Text input.
    context GoogleCloudDiscoveryengineV1alphaConversationContext
    Conversation context of the input.
    input String
    Text input.
    context GoogleCloudDiscoveryengineV1alphaConversationContext
    Conversation context of the input.
    input string
    Text input.
    context GoogleCloudDiscoveryengineV1alphaConversationContext
    Conversation context of the input.
    input str
    Text input.
    context Property Map
    Conversation context of the input.
    input String
    Text input.

    GoogleCloudDiscoveryengineV1alphaTextInputResponse, GoogleCloudDiscoveryengineV1alphaTextInputResponseArgs

    Context GoogleCloudDiscoveryengineV1alphaConversationContextResponse
    Conversation context of the input.
    Input string
    Text input.
    context GoogleCloudDiscoveryengineV1alphaConversationContextResponse
    Conversation context of the input.
    input String
    Text input.
    context GoogleCloudDiscoveryengineV1alphaConversationContextResponse
    Conversation context of the input.
    input string
    Text input.
    context GoogleCloudDiscoveryengineV1alphaConversationContextResponse
    Conversation context of the input.
    input str
    Text input.
    context Property Map
    Conversation context of the input.
    input String
    Text input.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native