Class CitationsBlock

constructor

• new CitationsBlock(data: CitationsBlockData): CitationsBlock

  Parameters

  • data: CitationsBlockData

  Returns CitationsBlock

Readonlytype

Readonlycitations

Readonlycontent

toJSON

• toJSON(): {
      citations: {
          citations: {
              location: | {
                  type: "documentChar";
                  documentIndex: number;
                  start: number;
                  end: number;
              }
              | {
                  type: "documentPage";
                  documentIndex: number;
                  start: number;
                  end: number;
              }
              | {
                  type: "documentChunk";
                  documentIndex: number;
                  start: number;
                  end: number;
              }
              | {
                  type: "searchResult";
                  searchResultIndex: number;
                  start: number;
                  end: number;
              }
              | { type: "web"; url: string; domain?: string };
              source: string;
              sourceContent: { text: string }[];
              title: string;
          }[];
          content: { text: string }[];
      };
  }

  Serializes the CitationsBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify().

  Returns {
      citations: {
          citations: {
              location:
                  | {
                      type: "documentChar";
                      documentIndex: number;
                      start: number;
                      end: number;
                  }
                  | {
                      type: "documentPage";
                      documentIndex: number;
                      start: number;
                      end: number;
                  }
                  | {
                      type: "documentChunk";
                      documentIndex: number;
                      start: number;
                      end: number;
                  }
                  | {
                      type: "searchResult";
                      searchResultIndex: number;
                      start: number;
                      end: number;
                  }
                  | { type: "web"; url: string; domain?: string };
              source: string;
              sourceContent: { text: string }[];
              title: string;
          }[];
          content: { text: string }[];
      };
  }

StaticfromJSON

• fromJSON(
      data: {
          citations: {
              citations: {
                  location:
                      | {
                          type: "documentChar";
                          documentIndex: number;
                          start: number;
                          end: number;
                      }
                      | {
                          type: "documentPage";
                          documentIndex: number;
                          start: number;
                          end: number;
                      }
                      | {
                          type: "documentChunk";
                          documentIndex: number;
                          start: number;
                          end: number;
                      }
                      | {
                          type: "searchResult";
                          searchResultIndex: number;
                          start: number;
                          end: number;
                      }
                      | { type: "web"; url: string; domain?: string };
                  source: string;
                  sourceContent: { text: string }[];
                  title: string;
              }[];
              content: { text: string }[];
          };
      },
  ): CitationsBlock

  Creates a CitationsBlock instance from its wrapped data format.

  Parameters

  • data: {
        citations: {
            citations: {
                location:
                    | {
                        type: "documentChar";
                        documentIndex: number;
                        start: number;
                        end: number;
                    }
                    | {
                        type: "documentPage";
                        documentIndex: number;
                        start: number;
                        end: number;
                    }
                    | {
                        type: "documentChunk";
                        documentIndex: number;
                        start: number;
                        end: number;
                    }
                    | {
                        type: "searchResult";
                        searchResultIndex: number;
                        start: number;
                        end: number;
                    }
                    | { type: "web"; url: string; domain?: string };
                source: string;
                sourceContent: { text: string }[];
                title: string;
            }[];
            content: { text: string }[];
        };
    }

    Wrapped CitationsBlockData to deserialize

  Returns CitationsBlock

  CitationsBlock instance