The Yi series models are large language models developed by 01.AI. They include Yi-6B and Yi-34B, which have 6 billion and 34 billion parameters respectively. There are also versions of these models with 200K context lengths. The models can be used for various NLP tasks such as text classification, sentiment analysis, question answering, etc. The models are available for academic research and free commercial usage with permission.

To query this model you need to provide a properly formatted input string.

```bash
curl "https://api.deepinfra.com/v1/inference/01-ai/Yi-34B-200K" \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $(deepctl auth token)" \
   -d '{
     "input": "[INST] Just say hi! [/INST] "
   }'
```

That will respond with:

```json
{
    "request_id": "RWZDRhS5kdoM1XWwXLEshynO",
    "inference_status": {
        "status": "succeeded",
        "runtime_ms": 243,
        "cost": 0.0,
        "tokens_generated": 3
    },
    "results": [
        {
            "generated_text": "Hi!"
        }
    ],
    "num_tokens": 3
}
```

To do a streaming request, just pass `"stream": true`:

```bash
curl "https://api.deepinfra.com/v1/inference/01-ai/Yi-34B-200K" \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $(deepctl auth token)" \
   -d '{
     "input": "[INST] Just say hi! [/INST] ",
     "stream": true
   }'
```

which outputs:

```json
data: {"token": {"id": 6324, "text": " Hi", "logprob": 0.0, "special": false}, "generated_text": null, "details": null}

data: {"token": {"id": 29991, "text": "!", "logprob": 0.0, "special": false}, "generated_text": null, "details": null}

data: {"token": {"id": 2, "text": "</s>", "logprob": -0.22229004, "special": true}, "generated_text": "Hi!", "details": {"finish_reason": "eos_token", "generated_tokens": 3, "input_tokens": 13, "seed": 16848278268029293276}}
```


The basic format of the input is:

```
[INST] first question [/INST] first answer</s><s>
[INST] second question [/INST] second answer</s><s>
[INST] final question [/INST]
```

If you want to add system prompt, modify the first question (newlines matter)

```
[INST] <<SYS>>
your system prompt goes here
<<SYS>>

first question [/INST] ...
```

For airoboros the prompt can be:

```
A chat.
USER: question
ASSISTANT:
```

Just stick an extra newline between prompts for history. Check [airoboros
prompt
format](https://huggingface.co/jondurbin/airoboros-l2-7b-2.2/blob/main/README.md#prompt-format)
for more info.


You can use our command-line tool [deepctl](/docs/getting-started) to run
inferences:

```bash
deepctl infer \
    -m '01-ai/Yi-34B-200K'  \
    -i 'input=I have this dream'
```

which will give you back something similar to:

```json
{
  "results": [
    {
      "generated_text": "I have this dream about the day I got a job at a tech company. I just woke up on a plane. I sat down on the floor and started getting work done. After getting up around 6 p.m., I looked around and"
    }
  ],
  "num_tokens": 42,
  "num_input_tokens": 100,
  "request_id": null,
  "inference_status": {
    "status": "unknown",
    "runtime_ms": 0,
    "cost": 0.0,
    "tokens_generated": 0,
    "tokens_input": 0
  }
}

```


You can POST to our OpenAI compatible endpoint:

```bash
curl "https://api.deepinfra.com/v1/openai/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $(deepctl auth token)" \
  -d '{
      "model": "01-ai/Yi-34B-200K",
      "prompt": "The quick brown fox"
    }'
```

To which you'd get something like:

```json
{
    "id": "cmpl-1b8401a68c5141eb825f68944dcea2c1",
    "object": "text_completion",
    "created": 1700578595,
    "model": "01-ai/Yi-34B-200K",
    "choices": [
        {
            "index": 0,
            "text": " jumped over the lazy dog",
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 4,
        "total_tokens": 9,
        "completion_tokens": 5
    }
}
```

You can also perform a streaming request by passing `"stream": true`:

```bash
curl "https://api.deepinfra.com/v1/openai/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $(deepctl auth token)" \
  -d '{
      "model": "01-ai/Yi-34B-200K",
      "stream": true,
      "prompt": "The quick brown fox"
    }'
```

to which you'd get a sequence of [SSE](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) events, finishing with `[DONE]`.

```
data: {"id": "cmpl-8e9b62b4fd924beb848c9d12d1bc86ec", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": " jumps", "finish_reason": null}]}

data: {"id": "cmpl-713aa1050f5a456f80743ff340749998", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": " over", "finish_reason": null}]}

data: {"id": "cmpl-6c45c4a8f3ed45d5823aee9c913b25e0", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": " the", "finish_reason": null}]}

data: {"id": "cmpl-4b78757fcff445509e38ca834c171c1a", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": " lazy", "finish_reason": null}]}

data: {"id": "cmpl-59c539a062b740e4aed11c5463f888fc", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": " dog", "finish_reason": null}]}

data: {"id": "cmpl-c7a6daa119c846ec9a3e2c1abd253f66", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": "", "finish_reason": null}]}

data: {"id": "cmpl-e9804392c4a34188b7e78a59ee1db792", "object": "text_completion", "created": 1700578719, "model": "01-ai/Yi-34B-200K", "choices": [{"index": 0, "text": "", "finish_reason": "stop"}]}

data: [DONE]

```

Currently supported parameters:
- `temperature` - more or less random generation
- `top_p` - controls token sampling
- `max_tokens` - maximum number of generated tokens
- `stop` - up to 4 strings to terminate generation earlier
- `n` - number of sequences to generate (up to 2)

Known caveats:
- if the generation is terminated due to a stop sequence, the stop sequence is
  present in the output (but in OpenAI it is not).


You can use the official openai python client to run inferences with us:

```python
# assume openai>=1.0.0
from openai import OpenAI

# Point OpenAI client to our endpoint, provide token
openai = OpenAI(
    api_key="<YOUR DEEPINFRA TOKEN: deepctl auth token>",
    base_url="https://api.deepinfra.com/v1/openai",
)

completion = openai.completions.create(
    model="01-ai/Yi-34B-200K",
    prompt="The quick brown fox",
)

print(completion.choices[0].text)
```

You can also use the streaming option:

```python
completion = openai.completions.create(
    model="01-ai/Yi-34B-200K",
    prompt="The quick brown fox",
    stream=True,
)

for event in completion:
    print(event.choices[0].text)
```

Currently supported parameters:
- `temperature` - more or less random generation
- `top_p` - controls token sampling
- `max_tokens` - maximum number of generated tokens
- `stop` - up to 4 strings to terminate generation earlier
- `n` - number of sequences to generate (up to 2)

Known caveats:
- if the generation is terminated due to a stop sequence, the stop sequence is
  present in the output (but in OpenAI it is not).


input

maximum length of the newly generated generated text

max_new_tokens

temperature to use for sampling. 0 means the output is deterministic. Values greater than 1 encourage more diversity

temperature

Sample from the set of tokens with highest probability such that sum of probabilies is higher than p. Lower values focus on the most probable tokens.Higher values sample more low-probability tokens

top_p

Sample from the best k (number of) tokens. 0 means off

top_k

repetition penalty. Value of 1 means no penalty, values greater than 1 discourage repetition, smaller than 1 encourage repetition.

repetition_penalty

Up to 4 strings that will terminate generation immediately

stop

Number of output sequences to return. Incompatible with streaming

num_responses

The webhook to call when inference is done, by default you will get the output in the response of your inference request

webhook

Whether to stream tokens, by default it will be false, currently only supported for Llama 2 text generation models, token by token updates will be sent over SSE

stream

Input

Max New Tokens

Num Responses

Repetition Penalty

Stop

Stream

Temperature

Top K

Top P

Webhook

TextGenerationIn

I have this dream about the day I got a job at a tech company. I just woke up on a plane. I sat down on the floor and started getting work done. After getting up around 6 p.m., I looked around and