@ondewo/nlu-client-typescript 6.11.0 → 6.13.0

package/api/ondewo/nlu/session_pb.d.ts

@@ -631,6 +631,16 @@ export class LlmTelemetry extends jspb.Message {
   getCcaiServiceProvider(): ondewo_nlu_ccai_project_pb.CcaiServiceProvider;
   setCcaiServiceProvider(value: ondewo_nlu_ccai_project_pb.CcaiServiceProvider): LlmTelemetry;
 
+  getLlmSafetyAssessment(): LlmSafetyAssessment | undefined;
+  setLlmSafetyAssessment(value?: LlmSafetyAssessment): LlmTelemetry;
+  hasLlmSafetyAssessment(): boolean;
+  clearLlmSafetyAssessment(): LlmTelemetry;
+
+  getLlmRetrievalMetadata(): LlmRetrievalMetadata | undefined;
+  setLlmRetrievalMetadata(value?: LlmRetrievalMetadata): LlmTelemetry;
+  hasLlmRetrievalMetadata(): boolean;
+  clearLlmRetrievalMetadata(): LlmTelemetry;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): LlmTelemetry.AsObject;
   static toObject(includeInstance: boolean, msg: LlmTelemetry): LlmTelemetry.AsObject;
@@ -701,6 +711,8 @@ export namespace LlmTelemetry {
     extraQuery?: google_protobuf_struct_pb.Struct.AsObject,
     extraBody?: google_protobuf_struct_pb.Struct.AsObject,
     ccaiServiceProvider: ondewo_nlu_ccai_project_pb.CcaiServiceProvider,
+    llmSafetyAssessment?: LlmSafetyAssessment.AsObject,
+    llmRetrievalMetadata?: LlmRetrievalMetadata.AsObject,
   }
 
   export enum DefaultHeadersCase { 
@@ -764,6 +776,136 @@ export namespace LlmTelemetry {
   }
 }
 
+export class LlmSafetyFinding extends jspb.Message {
+  getCategory(): string;
+  setCategory(value: string): LlmSafetyFinding;
+
+  getSeverity(): string;
+  setSeverity(value: string): LlmSafetyFinding;
+
+  getMatchedPattern(): string;
+  setMatchedPattern(value: string): LlmSafetyFinding;
+
+  getLocation(): LlmSafetyLocation;
+  setLocation(value: LlmSafetyLocation): LlmSafetyFinding;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LlmSafetyFinding.AsObject;
+  static toObject(includeInstance: boolean, msg: LlmSafetyFinding): LlmSafetyFinding.AsObject;
+  static serializeBinaryToWriter(message: LlmSafetyFinding, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LlmSafetyFinding;
+  static deserializeBinaryFromReader(message: LlmSafetyFinding, reader: jspb.BinaryReader): LlmSafetyFinding;
+}
+
+export namespace LlmSafetyFinding {
+  export type AsObject = {
+    category: string,
+    severity: string,
+    matchedPattern: string,
+    location: LlmSafetyLocation,
+  }
+}
+
+export class LlmSafetyAssessment extends jspb.Message {
+  getFlaggedCategoriesList(): Array<string>;
+  setFlaggedCategoriesList(value: Array<string>): LlmSafetyAssessment;
+  clearFlaggedCategoriesList(): LlmSafetyAssessment;
+  addFlaggedCategories(value: string, index?: number): LlmSafetyAssessment;
+
+  getHasPii(): boolean;
+  setHasPii(value: boolean): LlmSafetyAssessment;
+
+  getHasInjectionAttempt(): boolean;
+  setHasInjectionAttempt(value: boolean): LlmSafetyAssessment;
+
+  getHasJailbreakAttempt(): boolean;
+  setHasJailbreakAttempt(value: boolean): LlmSafetyAssessment;
+
+  getSafetyScore(): number;
+  setSafetyScore(value: number): LlmSafetyAssessment;
+
+  getFindingsList(): Array<LlmSafetyFinding>;
+  setFindingsList(value: Array<LlmSafetyFinding>): LlmSafetyAssessment;
+  clearFindingsList(): LlmSafetyAssessment;
+  addFindings(value?: LlmSafetyFinding, index?: number): LlmSafetyFinding;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LlmSafetyAssessment.AsObject;
+  static toObject(includeInstance: boolean, msg: LlmSafetyAssessment): LlmSafetyAssessment.AsObject;
+  static serializeBinaryToWriter(message: LlmSafetyAssessment, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LlmSafetyAssessment;
+  static deserializeBinaryFromReader(message: LlmSafetyAssessment, reader: jspb.BinaryReader): LlmSafetyAssessment;
+}
+
+export namespace LlmSafetyAssessment {
+  export type AsObject = {
+    flaggedCategoriesList: Array<string>,
+    hasPii: boolean,
+    hasInjectionAttempt: boolean,
+    hasJailbreakAttempt: boolean,
+    safetyScore: number,
+    findingsList: Array<LlmSafetyFinding.AsObject>,
+  }
+}
+
+export class LlmRetrievedChunk extends jspb.Message {
+  getDocumentId(): string;
+  setDocumentId(value: string): LlmRetrievedChunk;
+
+  getChunkId(): string;
+  setChunkId(value: string): LlmRetrievedChunk;
+
+  getScore(): number;
+  setScore(value: number): LlmRetrievedChunk;
+
+  getText(): string;
+  setText(value: string): LlmRetrievedChunk;
+
+  getSourceUri(): string;
+  setSourceUri(value: string): LlmRetrievedChunk;
+
+  getRank(): number;
+  setRank(value: number): LlmRetrievedChunk;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LlmRetrievedChunk.AsObject;
+  static toObject(includeInstance: boolean, msg: LlmRetrievedChunk): LlmRetrievedChunk.AsObject;
+  static serializeBinaryToWriter(message: LlmRetrievedChunk, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LlmRetrievedChunk;
+  static deserializeBinaryFromReader(message: LlmRetrievedChunk, reader: jspb.BinaryReader): LlmRetrievedChunk;
+}
+
+export namespace LlmRetrievedChunk {
+  export type AsObject = {
+    documentId: string,
+    chunkId: string,
+    score: number,
+    text: string,
+    sourceUri: string,
+    rank: number,
+  }
+}
+
+export class LlmRetrievalMetadata extends jspb.Message {
+  getChunksList(): Array<LlmRetrievedChunk>;
+  setChunksList(value: Array<LlmRetrievedChunk>): LlmRetrievalMetadata;
+  clearChunksList(): LlmRetrievalMetadata;
+  addChunks(value?: LlmRetrievedChunk, index?: number): LlmRetrievedChunk;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LlmRetrievalMetadata.AsObject;
+  static toObject(includeInstance: boolean, msg: LlmRetrievalMetadata): LlmRetrievalMetadata.AsObject;
+  static serializeBinaryToWriter(message: LlmRetrievalMetadata, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LlmRetrievalMetadata;
+  static deserializeBinaryFromReader(message: LlmRetrievalMetadata, reader: jspb.BinaryReader): LlmRetrievalMetadata;
+}
+
+export namespace LlmRetrievalMetadata {
+  export type AsObject = {
+    chunksList: Array<LlmRetrievedChunk.AsObject>,
+  }
+}
+
 export class LlmLatencyStats extends jspb.Message {
   getCallCount(): number;
   setCallCount(value: number): LlmLatencyStats;
@@ -1296,6 +1438,11 @@ export class LlmTelemetryReport extends jspb.Message {
   getToolCallDurationSecondsTotal(): number;
   setToolCallDurationSecondsTotal(value: number): LlmTelemetryReport;
 
+  getSafetyStats(): LlmSafetyStats | undefined;
+  setSafetyStats(value?: LlmSafetyStats): LlmTelemetryReport;
+  hasSafetyStats(): boolean;
+  clearSafetyStats(): LlmTelemetryReport;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): LlmTelemetryReport.AsObject;
   static toObject(includeInstance: boolean, msg: LlmTelemetryReport): LlmTelemetryReport.AsObject;
@@ -1325,6 +1472,65 @@ export namespace LlmTelemetryReport {
     thinkingDurationSecondsTotal: number,
     toolCallTokensTotal: number,
     toolCallDurationSecondsTotal: number,
+    safetyStats?: LlmSafetyStats.AsObject,
+  }
+}
+
+export class LlmSafetyCategoryStat extends jspb.Message {
+  getCategory(): string;
+  setCategory(value: string): LlmSafetyCategoryStat;
+
+  getCount(): number;
+  setCount(value: number): LlmSafetyCategoryStat;
+
+  getRate(): number;
+  setRate(value: number): LlmSafetyCategoryStat;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LlmSafetyCategoryStat.AsObject;
+  static toObject(includeInstance: boolean, msg: LlmSafetyCategoryStat): LlmSafetyCategoryStat.AsObject;
+  static serializeBinaryToWriter(message: LlmSafetyCategoryStat, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LlmSafetyCategoryStat;
+  static deserializeBinaryFromReader(message: LlmSafetyCategoryStat, reader: jspb.BinaryReader): LlmSafetyCategoryStat;
+}
+
+export namespace LlmSafetyCategoryStat {
+  export type AsObject = {
+    category: string,
+    count: number,
+    rate: number,
+  }
+}
+
+export class LlmSafetyStats extends jspb.Message {
+  getTotalAssessed(): number;
+  setTotalAssessed(value: number): LlmSafetyStats;
+
+  getFlaggedCount(): number;
+  setFlaggedCount(value: number): LlmSafetyStats;
+
+  getOverallSafetyScore(): number;
+  setOverallSafetyScore(value: number): LlmSafetyStats;
+
+  getCategoryStatsList(): Array<LlmSafetyCategoryStat>;
+  setCategoryStatsList(value: Array<LlmSafetyCategoryStat>): LlmSafetyStats;
+  clearCategoryStatsList(): LlmSafetyStats;
+  addCategoryStats(value?: LlmSafetyCategoryStat, index?: number): LlmSafetyCategoryStat;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LlmSafetyStats.AsObject;
+  static toObject(includeInstance: boolean, msg: LlmSafetyStats): LlmSafetyStats.AsObject;
+  static serializeBinaryToWriter(message: LlmSafetyStats, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LlmSafetyStats;
+  static deserializeBinaryFromReader(message: LlmSafetyStats, reader: jspb.BinaryReader): LlmSafetyStats;
+}
+
+export namespace LlmSafetyStats {
+  export type AsObject = {
+    totalAssessed: number,
+    flaggedCount: number,
+    overallSafetyScore: number,
+    categoryStatsList: Array<LlmSafetyCategoryStat.AsObject>,
   }
 }
 
@@ -1536,6 +1742,56 @@ export namespace LlmTokenUsageUpdateEvent {
   }
 }
 
+export class ReferencedChunk extends jspb.Message {
+  getReferenceIndex(): number;
+  setReferenceIndex(value: number): ReferencedChunk;
+
+  getDatasetId(): string;
+  setDatasetId(value: string): ReferencedChunk;
+
+  getDocumentId(): string;
+  setDocumentId(value: string): ReferencedChunk;
+
+  getChunkId(): string;
+  setChunkId(value: string): ReferencedChunk;
+
+  getDocumentName(): string;
+  setDocumentName(value: string): ReferencedChunk;
+
+  getContent(): string;
+  setContent(value: string): ReferencedChunk;
+
+  getSimilarity(): number;
+  setSimilarity(value: number): ReferencedChunk;
+
+  getDocumentUrl(): string;
+  setDocumentUrl(value: string): ReferencedChunk;
+
+  getDeepLinkUrl(): string;
+  setDeepLinkUrl(value: string): ReferencedChunk;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): ReferencedChunk.AsObject;
+  static toObject(includeInstance: boolean, msg: ReferencedChunk): ReferencedChunk.AsObject;
+  static serializeBinaryToWriter(message: ReferencedChunk, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): ReferencedChunk;
+  static deserializeBinaryFromReader(message: ReferencedChunk, reader: jspb.BinaryReader): ReferencedChunk;
+}
+
+export namespace ReferencedChunk {
+  export type AsObject = {
+    referenceIndex: number,
+    datasetId: string,
+    documentId: string,
+    chunkId: string,
+    documentName: string,
+    content: string,
+    similarity: number,
+    documentUrl: string,
+    deepLinkUrl: string,
+  }
+}
+
 export class QueryResult extends jspb.Message {
   getQueryText(): string;
   setQueryText(value: string): QueryResult;
@@ -1604,6 +1860,11 @@ export class QueryResult extends jspb.Message {
   hasLlmTelemetryReport(): boolean;
   clearLlmTelemetryReport(): QueryResult;
 
+  getReferencedChunksList(): Array<ReferencedChunk>;
+  setReferencedChunksList(value: Array<ReferencedChunk>): QueryResult;
+  clearReferencedChunksList(): QueryResult;
+  addReferencedChunks(value?: ReferencedChunk, index?: number): ReferencedChunk;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): QueryResult.AsObject;
   static toObject(includeInstance: boolean, msg: QueryResult): QueryResult.AsObject;
@@ -1631,6 +1892,7 @@ export namespace QueryResult {
     languageCode: string,
     fileResourcesList: Array<FileResource.AsObject>,
     llmTelemetryReport?: LlmTelemetryReport.AsObject,
+    referencedChunksList: Array<ReferencedChunk.AsObject>,
   }
 }
 
@@ -4561,6 +4823,11 @@ export enum ReasoningEffort {
   REASONING_EFFORT_MEDIUM = 3,
   REASONING_EFFORT_HIGH = 4,
 }
+export enum LlmSafetyLocation { 
+  LLM_SAFETY_LOCATION_UNSPECIFIED = 0,
+  LLM_SAFETY_LOCATION_INPUT = 1,
+  LLM_SAFETY_LOCATION_OUTPUT = 2,
+}
 export enum AudioEncoding { 
   AUDIO_ENCODING_UNSPECIFIED = 0,
   AUDIO_ENCODING_LINEAR_16 = 1,