Skip to main content

PersonaInteractRequest

context_document_ids object

Workspace documents to ground the reply on, as in a chat session with attachments.

anyOf
  • Array [
    • string
  • ]
    • document_id object

    A workspace document to react to; its content is added to the prompt and the type defaults to analysis.

    anyOf
    string
    enable_follow_up_questionsEnable Follow Up Questions

    Append suggested follow-up questions to the reply.

    Default value: false
    ground_with_google_search object

    Let the model search the web before answering.

    anyOf
    boolean
    input_contentInput Contentrequired

    What to put in front of the persona: a question, a draft, or pasted text.

    Example: We are moving to usage-based pricing next quarter. How does that land with you?
    interaction_name object

    A label for this interaction, kept with the record.

    anyOf
    string
    interaction_typeInteraction Type

    communication (react to content), conversation (chat), analysis (reason over a document) or simulation.

    Default value: communication
    Example: conversation
    message object

    Legacy alias for input_content.

    anyOf
    string
    model object

    Override the workspace's default model for this call.

    anyOf
    string
    persona_idPersona Idrequired

    The persona to ask. Also accepts the persona's exact name.

    Example: d4e9b2a1-6c3f-4b8e-9f21-0a7c5e3d1b60
    persona_override object

    An inline persona (name, description, tone, interests, concerns, communication_style) used instead of a stored one.

    anyOf
    property name*any
    response_language object

    BCP-47 tag for the reply language; defaults to the persona's, then the workspace market language.

    anyOf
    string
    voice_profile_id object

    Answer in one of the persona's named voice profiles instead of the default.

    anyOf
    string
    property name*any
    PersonaInteractRequest
    {
      "context_document_ids": [
        "string"
      ],
      "document_id": "string",
      "enable_follow_up_questions": false,
      "ground_with_google_search": true,
      "input_content": "We are moving to usage-based pricing next quarter. How does that land with you?",
      "interaction_name": "string",
      "interaction_type": "conversation",
      "message": "string",
      "model": "string",
      "persona_id": "d4e9b2a1-6c3f-4b8e-9f21-0a7c5e3d1b60",
      "persona_override": {},
      "response_language": "string",
      "voice_profile_id": "string"
    }