Function logDocumentAnnotations

  • logDocumentAnnotations(
        params: LogDocumentAnnotationsParams,
    ): Promise<{ id: string }[]>

    Log multiple document annotations in a single request.

    Each annotation can be of type "LLM", "CODE", or "HUMAN" and can include a label, score, explanation, and metadata. At least one of label, score, or explanation must be provided for each annotation.

    Parameters

    Returns Promise<{ id: string }[]>

    The IDs of the created annotations

    Example

    const results = await logDocumentAnnotations({
      documentAnnotations: [
        {
          spanId: "123abc",
          documentPosition: 0,
          name: "relevance_score",
          label: "relevant",
          score: 0.95,
          annotatorKind: "LLM",
          explanation: "Document is highly relevant to the query",
          metadata: {
            model: "gpt-4"
          }
        },
        {
          spanId: "123abc",
          documentPosition: 1,
          name: "relevance_score",
          label: "somewhat_relevant",
          score: 0.6,
          annotatorKind: "LLM"
        }
      ]
    });

Settings

Member Visibility