Arize Phoenix TS
    Preparing search index...

    Interface GetSpansParams

    Parameters to get spans from a project using auto-generated types

    interface GetSpansParams {
        client?: {
            config: ClientOptions;
            DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
            GET: ClientMethod<paths, "get", `${string}/${string}`>;
            getServerVersion: () => Promise<SemanticVersion>;
            HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
            OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
            PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
            POST: ClientMethod<paths, "post", `${string}/${string}`>;
            PUT: ClientMethod<paths, "put", `${string}/${string}`>;
            TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
            eject(...middleware: Middleware[]): void;
            use(...middleware: Middleware[]): void;
        };
        cursor?: string
        | null;
        endTime?: string | Date | null;
        limit?: number;
        name?: string | string[] | null;
        parentId?: string | null;
        project: ProjectIdentifier;
        spanKind?: SpanKindFilter | SpanKindFilter[] | null;
        startTime?: string | Date | null;
        statusCode?: SpanStatusCode | SpanStatusCode[] | null;
        traceIds?: string[] | null;
    }

    Hierarchy (View Summary)

    Index

    Properties

    client? cursor? endTime? limit? name? parentId? project spanKind? startTime? statusCode? traceIds?

    Properties

    client?: {
        config: ClientOptions;
        DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
        GET: ClientMethod<paths, "get", `${string}/${string}`>;
        getServerVersion: () => Promise<SemanticVersion>;
        HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
        OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
        PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
        POST: ClientMethod<paths, "post", `${string}/${string}`>;
        PUT: ClientMethod<paths, "put", `${string}/${string}`>;
        TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
        eject(...middleware: Middleware[]): void;
        use(...middleware: Middleware[]): void;
    }

    An instance of the Phoenix client. If not provided, the client will be created using the default configuration.

    Type Declaration

    • config: ClientOptions
    • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

      Call a DELETE endpoint

    • GET: ClientMethod<paths, "get", `${string}/${string}`>

      Call a GET endpoint

    • getServerVersion: () => Promise<SemanticVersion>

      Get the Phoenix server version, returning a cached value if available.

      The version is first populated from the x-phoenix-server-version response header on any API call. If no version has been seen yet, this method fetches GET /arize_phoenix_version to populate the cache.

      If the server version cannot be determined (e.g. the server is unreachable or returned an unparseable version string).

    • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

      Call a HEAD endpoint

    • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

      Call a OPTIONS endpoint

    • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

      Call a PATCH endpoint

    • POST: ClientMethod<paths, "post", `${string}/${string}`>

      Call a POST endpoint

    • PUT: ClientMethod<paths, "put", `${string}/${string}`>

      Call a PUT endpoint

    • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

      Call a TRACE endpoint

    • eject: function
      • eject(...middleware: Middleware[]): void

        Unregister middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    • use: function
      • use(...middleware: Middleware[]): void

        Register middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    cursor?: string | null

    Pagination cursor (Span Global ID)

    endTime?: string | Date | null

    Exclusive upper bound time. Must be a valid ISO 8601 string or Date object.

    limit?: number

    Maximum number of spans to return

    name?: string | string[] | null

    Filter by span name(s)

    parentId?: string | null

    Filter by parent span ID. Use null or the string "null" to get root spans only.

    project: ProjectIdentifier

    The project to get spans from

    spanKind?: SpanKindFilter | SpanKindFilter[] | null

    Filter by span kind(s) (LLM, CHAIN, TOOL, RETRIEVER, etc.)

    startTime?: string | Date | null

    Inclusive lower bound time. Must be a valid ISO 8601 string or Date object.

    statusCode?: SpanStatusCode | SpanStatusCode[] | null

    Filter by status code(s) (OK, ERROR, UNSET)

    traceIds?: string[] | null

    Filter spans by one or more trace IDs

    Settings

    Member Visibility

    On This Page

    Properties