Genkit JS API reference
    Preparing search index...

    Type Alias RankedDocumentData

    RankedDocumentData: {
        content: (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest: {
                    input?: unknown;
                    name: string;
                    partial?: boolean;
                    ref?: string;
                };
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse: { name: string; output?: unknown; ref?: string } & {
                    content?: (
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource?: undefined;
                            text: string;
                            toolRequest?: undefined;
                            toolResponse?: undefined;
                        }
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media: { contentType?: ...; url: ... };
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource?: undefined;
                            text?: undefined;
                            toolRequest?: undefined;
                            toolResponse?: undefined;
                        }
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource?: undefined;
                            text?: undefined;
                            toolRequest: { input?: ...; name: ...; partial?: ...; ref?: ... };
                            toolResponse?: undefined;
                        }
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource?: undefined;
                            text?: undefined;
                            toolRequest?: undefined;
                            toolResponse: (...) & (...);
                        }
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource?: undefined;
                            text?: undefined;
                            toolRequest?: undefined;
                            toolResponse?: undefined;
                        }
                        | {
                            custom: Record<(...), (...)>;
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource?: undefined;
                            text?: undefined;
                            toolRequest?: undefined;
                            toolResponse?: undefined;
                        }
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning: string;
                            resource?: undefined;
                            text?: undefined;
                            toolRequest?: undefined;
                            toolResponse?: undefined;
                        }
                        | {
                            custom?: (...)
                            | (...);
                            data?: unknown;
                            media?: undefined;
                            metadata?: (...) | (...);
                            reasoning?: undefined;
                            resource: { uri: ... };
                            text?: undefined;
                            toolRequest?: undefined;
                            toolResponse?: undefined;
                        }
                    )[];
                };
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom: Record<string, any>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning: string;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource: { uri: string };
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[];
        metadata: { score: number } & { [k: string]: unknown };
    }

    Type Declaration

    • content: (
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text: string;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media: { contentType?: string; url: string };
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest: {
                  input?: unknown;
                  name: string;
                  partial?: boolean;
                  ref?: string;
              };
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse: { name: string; output?: unknown; ref?: string } & {
                  content?: (
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource?: undefined;
                          text: string;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media: { contentType?: ...; url: ... };
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource?: undefined;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource?: undefined;
                          text?: undefined;
                          toolRequest: { input?: ...; name: ...; partial?: ...; ref?: ... };
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource?: undefined;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse: (...) & (...);
                      }
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource?: undefined;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom: Record<(...), (...)>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource?: undefined;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning: string;
                          resource?: undefined;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: (...)
                          | (...);
                          data?: unknown;
                          media?: undefined;
                          metadata?: (...) | (...);
                          reasoning?: undefined;
                          resource: { uri: ... };
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                  )[];
              };
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom: Record<string, any>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning: string;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource: { uri: string };
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
      )[]
    • metadata: { score: number } & { [k: string]: unknown }