plugNmeet JS SDK - v2.0.3
    Preparing search index...

    Type Alias RoomArtifactMetadata

    RoomArtifactMetadata: Message<"plugnmeet.RoomArtifactMetadata"> & {
        userInfo?: RoomArtifactUserInfo;
        providerJobInfo?: RoomArtifactProviderJobInfo;
        fileInfo?: RoomArtifactFileInfo;
        usageDetails:
            | { value: RoomArtifactTokenUsage; case: "tokenUsage" }
            | { value: RoomArtifactDurationUsage; case: "durationUsage" }
            | { value: RoomArtifactCharacterCountUsage; case: "characterCountUsage" }
            | { case: undefined; value?: undefined };
        referenceArtifactId?: string;
    }

    RoomArtifactMetadata is the universal structure for the 'metadata' JSON field in the pnm_room_artifacts table. All fields are optional.

    Type Declaration

    • OptionaluserInfo?: RoomArtifactUserInfo

      Optional: Information about the user who initiated or is associated with the artifact.

      from field: plugnmeet.RoomArtifactUserInfo user_info = 1;

    • OptionalproviderJobInfo?: RoomArtifactProviderJobInfo

      Optional: Information about an asynchronous provider job.

      from field: plugnmeet.RoomArtifactProviderJobInfo provider_job_info = 2;

    • OptionalfileInfo?: RoomArtifactFileInfo

      Optional: Information about the final generated file artifact.

      from field: plugnmeet.RoomArtifactFileInfo file_info = 3;

    • usageDetails:
          | { value: RoomArtifactTokenUsage; case: "tokenUsage" }
          | { value: RoomArtifactDurationUsage; case: "durationUsage" }
          | { value: RoomArtifactCharacterCountUsage; case: "characterCountUsage" }
          | { case: undefined; value?: undefined }

      A field for different types of usage metrics.

      from oneof plugnmeet.RoomArtifactMetadata.usage_details

    • OptionalreferenceArtifactId?: string

      A field to link a file artifact back to its usage artifact.

      from field: optional string reference_artifact_id = 10;

    from message plugnmeet.RoomArtifactMetadata