generative-ts

Interface CohereChatResponse

interface CohereChatResponse {
    chat_history: ({
        role: string;
    } & {
        message?: string;
        tool_calls?: {
            name: string;
            parameters: {};
        }[];
        tool_results?: {
            call: {
                name: string;
                parameters: {};
            };
            outputs: {}[];
        }[];
    })[];
    citations?: {
        document_ids: string[];
        end: number;
        start: number;
        text: string;
    }[];
    documents?: {}[];
    finish_reason: string;
    generation_id: string;
    is_search_required?: boolean;
    meta: {
        api_version: {
            version: string;
        } & {
            is_deprecated?: boolean;
            is_experimental?: boolean;
        };
        billed_units: {
            input_tokens: number;
            output_tokens: number;
        } & {
            classifications?: number;
            search_units?: number;
        };
        tokens: {
            output_tokens: number;
        } & {
            input_tokens?: number;
        };
    } & {
        warnings?: string[];
    };
    response_id?: string;
    search_queries?: {
        generation_id: string;
        text: string;
    }[];
    search_results?: {
        connector: {
            id: string;
        };
        continue_on_failure: boolean;
        document_ids: string[];
        error_message: string;
        search_query: {
            generation_id: string;
            text: string;
        };
    }[];
    text: string;
    tool_calls?: {
        name: string;
        parameters: {};
    }[];
}

Hierarchy

  • TypeOf<typeof CohereChatResponseCodec>
    • CohereChatResponse

Properties

chat_history citations? documents? finish_reason generation_id is_search_required? meta response_id? search_queries? search_results? text tool_calls?

Properties

chat_history

chat_history: ({
    role: string;
} & {
    message?: string;
    tool_calls?: {
        name: string;
        parameters: {};
    }[];
    tool_results?: {
        call: {
            name: string;
            parameters: {};
        };
        outputs: {}[];
    }[];
})[]

Optional citations

citations?: {
    document_ids: string[];
    end: number;
    start: number;
    text: string;
}[]

Type declaration

  • document_ids: string[]
  • end: number
  • start: number
  • text: string

Optional documents

documents?: {}[]

Type declaration

    finish_reason

    finish_reason: string

    generation_id

    generation_id: string

    Optional is_search_required

    is_search_required?: boolean

    meta

    meta: {
        api_version: {
            version: string;
        } & {
            is_deprecated?: boolean;
            is_experimental?: boolean;
        };
        billed_units: {
            input_tokens: number;
            output_tokens: number;
        } & {
            classifications?: number;
            search_units?: number;
        };
        tokens: {
            output_tokens: number;
        } & {
            input_tokens?: number;
        };
    } & {
        warnings?: string[];
    }

    Type declaration

    • api_version: {
          version: string;
      } & {
          is_deprecated?: boolean;
          is_experimental?: boolean;
      }
    • billed_units: {
          input_tokens: number;
          output_tokens: number;
      } & {
          classifications?: number;
          search_units?: number;
      }
    • tokens: {
          output_tokens: number;
      } & {
          input_tokens?: number;
      }

    Type declaration

    • Optional warnings?: string[]

    Optional response_id

    response_id?: string

    Optional search_queries

    search_queries?: {
        generation_id: string;
        text: string;
    }[]

    Type declaration

    • generation_id: string
    • text: string

    Optional search_results

    search_results?: {
        connector: {
            id: string;
        };
        continue_on_failure: boolean;
        document_ids: string[];
        error_message: string;
        search_query: {
            generation_id: string;
            text: string;
        };
    }[]

    Type declaration

    • connector: {
          id: string;
      }
      • id: string
    • continue_on_failure: boolean
    • document_ids: string[]
    • error_message: string
    • search_query: {
          generation_id: string;
          text: string;
      }
      • generation_id: string
      • text: string

    text

    text: string

    Optional tool_calls

    tool_calls?: {
        name: string;
        parameters: {};
    }[]

    Type declaration

    • name: string
    • parameters: {}