参数

• conversation (list[dict[str, str]]) — 包含“role”和“content”键的字典列表，代表迄今为止的聊天历史。
• documents (list[dict[str, str]) — 字典列表，代表用于支持生成内容的文档或工具输出。文档是一个半结构化的字典，带有字符串到字符串的映射。常见字段包括 url、title、snippet 等，但应描述其键的含义。它们将被渲染到提示中。
• citation_mode — “accurate”（提示模型先生成答案，然后在答案中重写引用跨度）或“fast”（提示模型直接生成带有引用的答案）。前者引用质量更高，后者生成的 token 更少。
• add_generation_prompt (bool, 可选) — 是否在提示末尾添加指示助手消息开始的 token(s)。当你希望模型生成响应时，这很有用。请注意，此参数将传递给聊天模板，因此模板必须支持此参数才能使其生效。
• tokenize (bool, 默认为 True) — 是否对输出进行分词。如果为 False，输出将是一个字符串。
• padding (bool, 默认为 False) — 是否填充序列以达到最大长度。如果 tokenize 为 False，则无效。
• truncation (bool, 默认为 False) — 是否截断序列到最大长度。如果 tokenize 为 False，则无效。
• max_length (int, 可选) — 用于填充或截断的最大长度（以 token 为单位）。如果 tokenize 为 False，则无效。如果未指定，分词器的 max_length 属性将用作默认值。
• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回特定框架的张量。如果 tokenize 为 False，则无效。可接受的值包括：
  • 'pt': 返回 PyTorch torch.Tensor 对象。
  • 'np': 返回 NumPy np.ndarray 对象。
• return_dict (bool, 可选, 默认为 False) — 是否返回具有命名输出的字典。如果 tokenize 为 False，则无效。
• **tokenizer_kwargs — 传递给分词器的附加关键字参数。

渲染后的提示字符串。或者如果 tokenize=True: list[int]: 表示分词后聊天历史的 token ID 列表，包括控制 token。此输出已准备好直接或通过 generate() 等方法传递给模型。

参数

• conversation (list[dict[str, str]]) — 包含“role”和“content”键的字典列表，代表迄今为止的聊天历史。
• tools (list[Dict]) — 要渲染到提示中供模型选择的工具列表。请参阅 docstring 底部的一个示例。格式应为：
  • name (str): 要调用的工具的名称。有效名称仅包含字符 a-z、A-Z、0-9、_ 且不得以数字开头。
  • description (str): 工具功能的描述，模型使用该描述来决定何时以及如何调用函数。
  • parameter_definitions (list[Dict]): 工具的输入参数。接受一个字典，其中键是参数的名称，值是参数规范。有效参数名称仅包含字符 a-z、A-Z、0-9、_ 且不得以数字开头。参数规范如下：
    • description (str): 参数的描述。
    • type (str): 参数的类型——对 python 内置数据类型（如 'str'、'bool'）最有效
    • required: boolean: 表示参数是否始终存在（必需）或否。默认为不必需。
• add_generation_prompt (bool, 可选) — 是否在提示末尾添加指示助手消息开始的 token(s)。当你希望模型生成响应时，这很有用。请注意，此参数将传递给聊天模板，因此模板必须支持此参数才能使其生效。
• tokenize (bool, 默认为 True) — 是否对输出进行分词。如果为 False，则输出将是一个字符串。
• padding (bool, 默认为 False) — 是否将序列填充到最大长度。如果 tokenize 为 False 则无效。
• truncation (bool, 默认为 False) — 是否将序列截断到最大长度。如果 tokenize 为 False 则无效。
• max_length (int, 可选) — 用于填充或截断的最大长度（以 token 为单位）。如果 tokenize 为 False 则无效。如果未指定，则默认使用分词器的 max_length 属性。
• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回特定框架的张量。如果 tokenize 为 False 则无效。可接受的值包括：
  • 'pt': 返回 PyTorch torch.Tensor 对象。
  • 'np': 返回 NumPy np.ndarray 对象。
• return_dict (bool, 可选, 默认为 False) — 是否返回一个带有命名输出的字典。如果 tokenize 为 False 则无效。
• **tokenizer_kwargs — 传递给分词器的额外关键字参数。

渲染后的提示字符串。或者如果 tokenize=True: list[int]: 表示分词后聊天历史的 token ID 列表，包括控制 token。此输出已准备好直接或通过 generate() 等方法传递给模型。

参数

• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认会忽略填充。

  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什么是输入 ID？

• attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 用于避免对填充 token 索引进行注意力计算的掩码。掩码值选择在 [0, 1] 中：
  • 1 表示未掩码的 token，
  • 0 表示已掩码的 token。

  什么是注意力掩码？

• position_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

  什么是位置 ID？

• past_key_values (~cache_utils.Cache, 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在 use_cache=True 或 config.use_cache=True 时，模型在先前解码阶段返回的 past_key_values。

  仅允许 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

  模型将输出与输入相同的缓存格式。

  如果使用 past_key_values，用户应仅输入未处理的 input_ids（那些未将其 past key value 状态传递给此模型的），形状为 (batch_size, unprocessed_length)，而不是所有 input_ids，形状为 (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以直接传入嵌入表示，而不是传入 input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关的向量，这将非常有用。
• cache_position (torch.LongTensor，形状为 (sequence_length), 可选) — 描述输入序列 token 在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
• use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。

一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一系列 torch.FloatTensor（如果传入了 return_dict=False 或当 config.return_dict=False 时），具体取决于配置（CohereConfig）和输入。

• last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

• past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

  Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) to speed up sequential decoding.

• hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

• attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认会忽略填充。

  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什么是输入 ID？

• attention_mask (torch.Tensor, 形状为 (batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值选择自 [0, 1]：
  • 1 表示未掩码的 token，
  • 0 表示已掩码的 token。

  什么是 attention masks？

• position_ids (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 每个输入序列 token 在位置 embedding 中的位置索引。选择范围为 [0, config.n_positions - 1]。

  什么是 position IDs？

• past_key_values (~cache_utils.Cache, 可选) — 预计算的隐藏状态（自 attention 块和跨 attention 块中的 key 和 values），可用于加速序列解码。这通常包括在 use_cache=True 或 config.use_cache=True 时，在上一个解码阶段由模型返回的 past_key_values。

  只有 Cache 实例允许作为输入，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

  模型将输出与输入相同的 cache 格式。

  如果使用 past_key_values，用户应仅传入未处理的 input_ids（即其 past key value 状态未提供给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 input_ids，形状为 (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以使用嵌入表示代替 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。
• labels (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言模型损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100（请参阅 input_ids 文档字符串）。索引设置为 -100 的 token 将被忽略（掩码），损失仅为索引在 [0, ..., config.vocab_size] 中的 token 计算。
• use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values key value 状态，并可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
• cache_position (torch.LongTensor, 形状为 (sequence_length), 可选) — 描绘输入序列 token 在序列中的位置的索引。与 position_ids 不同，此张量不受 padding 影响。它用于在正确的位置更新 cache 并推断完整的序列长度。
• logits_to_keep (Union[int, torch.Tensor], 可选, 默认为 0) — 如果为 int，则计算最后 logits_to_keep 个 token 的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。仅在生成时需要最后一个 token 的 logits，并且仅为该 token 计算它们可以节省内存，这对于长序列或大词汇量来说非常重要。如果为 torch.Tensor，则必须是 1D，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度的单维）时很有用。

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个包含各种元素的元组（如果传递了 return_dict=False 或 config.return_dict=False 时）。具体元素取决于配置（CohereConfig）和输入。

• loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。

• logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。

• past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

  包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

• hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

• attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。