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

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.getConversation

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

    Gets a Conversation.

    Using getConversation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConversation(args: GetConversationArgs, opts?: InvokeOptions): Promise<GetConversationResult>
function getConversationOutput(args: GetConversationOutputArgs, opts?: InvokeOptions): Output<GetConversationResult>
    def get_conversation(collection_id: Optional[str] = None,
                     conversation_id: Optional[str] = None,
                     data_store_id: Optional[str] = None,
                     location: Optional[str] = None,
                     project: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetConversationResult
def get_conversation_output(collection_id: Optional[pulumi.Input[str]] = None,
                     conversation_id: Optional[pulumi.Input[str]] = None,
                     data_store_id: Optional[pulumi.Input[str]] = None,
                     location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetConversationResult]
    func LookupConversation(ctx *Context, args *LookupConversationArgs, opts ...InvokeOption) (*LookupConversationResult, error)
func LookupConversationOutput(ctx *Context, args *LookupConversationOutputArgs, opts ...InvokeOption) LookupConversationResultOutput

    > Note: This function is named LookupConversation in the Go SDK.

    public static class GetConversation 
{
    public static Task<GetConversationResult> InvokeAsync(GetConversationArgs args, InvokeOptions? opts = null)
    public static Output<GetConversationResult> Invoke(GetConversationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConversationResult> getConversation(GetConversationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:discoveryengine/v1alpha:getConversation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CollectionId string
    ConversationId string
    DataStoreId string
    Location string
    Project string
    CollectionId string
    ConversationId string
    DataStoreId string
    Location string
    Project string
    collectionId String
    conversationId String
    dataStoreId String
    location String
    project String
    collectionId string
    conversationId string
    dataStoreId string
    location string
    project string
    collectionId String
    conversationId String
    dataStoreId String
    location String
    project String

    getConversation Result

    The following output properties are available:

    EndTime string
    The time the conversation finished.
    Messages List<Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaConversationMessageResponse>
    Conversation messages.
    Name string
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    StartTime string
    The time the conversation started.
    State string
    The state of the Conversation.
    UserPseudoId string
    A unique identifier for tracking users.
    EndTime string
    The time the conversation finished.
    Messages []GoogleCloudDiscoveryengineV1alphaConversationMessageResponse
    Conversation messages.
    Name string
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    StartTime string
    The time the conversation started.
    State string
    The state of the Conversation.
    UserPseudoId string
    A unique identifier for tracking users.
    endTime String
    The time the conversation finished.
    messages List<GoogleCloudDiscoveryengineV1alphaConversationMessageResponse>
    Conversation messages.
    name String
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    startTime String
    The time the conversation started.
    state String
    The state of the Conversation.
    userPseudoId String
    A unique identifier for tracking users.
    endTime string
    The time the conversation finished.
    messages GoogleCloudDiscoveryengineV1alphaConversationMessageResponse[]
    Conversation messages.
    name string
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    startTime string
    The time the conversation started.
    state string
    The state of the Conversation.
    userPseudoId string
    A unique identifier for tracking users.
    end_time str
    The time the conversation finished.
    messages Sequence[GoogleCloudDiscoveryengineV1alphaConversationMessageResponse]
    Conversation messages.
    name str
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    start_time str
    The time the conversation started.
    state str
    The state of the Conversation.
    user_pseudo_id str
    A unique identifier for tracking users.
    endTime String
    The time the conversation finished.
    messages List<Property Map>
    Conversation messages.
    name String
    Immutable. Fully qualified name project/*/locations/global/collections/{collection}/dataStore/*/conversations/*
    startTime String
    The time the conversation started.
    state String
    The state of the Conversation.
    userPseudoId String
    A unique identifier for tracking users.

    Supporting Types

    GoogleCloudDiscoveryengineV1alphaConversationContextResponse

    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.

    GoogleCloudDiscoveryengineV1alphaConversationMessageResponse

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

    GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse

    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

    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.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse

    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.

    GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse

    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.

    GoogleCloudDiscoveryengineV1alphaTextInputResponse

    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